_get_term_children

Private AccessPrivate Access

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

SummerySummery

Get the subset of $terms that are descendants of $term_id.

Syntax

_get_term_children( int $term_id, array $terms, string $taxonomy, array $ancestors = array() )

DescriptionDescription

If $terms is an array of objects, then _get_term_children() returns an array of objects. If $terms is an array of IDs, then _get_term_children() returns an array of IDs.

ParametersParameters

$term_id

(int) (Required) The ancestor term: all returned terms should be descendants of $term_id.

$terms

(array) (Required) The set of terms - either an array of term objects or term IDs - from which those that are descendants of $term_id will be chosen.

$taxonomy

(string) (Required) The taxonomy which determines the hierarchy of the terms.

$ancestors

(array) (Optional) Term ancestors that have already been identified. Passed by reference, to keep track of found terms when recursing the hierarchy. The array of located ancestors is used to prevent infinite recursion loops. For performance, term_ids are used as array keys, with 1 as value.

Default value: array()

ReturnReturn

(array|WP_Error) The subset of $terms that are descendants of $term_id.

SourceSource

File: wp-includes/taxonomy.php


			

ChangelogChangelog

Changelog
Version Description
2.3.0 Introduced.
Scroll to Top