WordPress.org

Function Reference/get term children

Description

Merge all term children into a single array.

This recursive function will merge all of the children of $term into the same array. Only useful for taxonomies which are hierarchical.

Will return an empty array if $term does not exist in $taxonomy.

Usage

<?php get_term_children( $term, $taxonomy ) ?>

Parameters

$term

(string) (required) ID of Term to get children

Default: None

$taxonomy

(string) (required) Taxonomy Name

Default: None

Return Values

(array|WP_Error): List of Term Objects. WP_Error returned if $taxonomy does not exist

Examples

A Basic Example

Used to get an array of children taxonomies and write them out with links in an unordered list.

<?php
$termID = 10;
$taxonomyName = "products";
$termchildren = get_term_children( $termID, $taxonomyName );

echo '<ul>';
foreach ($termchildren as $child) {
	$term = get_term_by( 'id', $child, $taxonomyName );
	echo '<li><a href="' . get_term_link( $term->name, $taxonomyName ) . '">' . $term->name . '</a></li>';
}
echo '</ul>';
?>

This would return something like.

<ul> 
<li><a href="link_to_term_page">Term 1</a></li>
<li><a href="link_to_term_page">Term 2</a></li>
</ul>

Notes

Uses: $wpdb
Uses: _get_term_hierarchy()
Uses: get_term_children Used to get the children of both $taxonomy and the parent $term

Change Log

Since: 2.3.0

Source File

get_term_children() is located in wp-includes/taxonomy.php.

WordPress.org

Codex