WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_term_parents_list()

get_term_parents_list( int $term_id, string $taxonomy, string|array $args = array() ): string|WP_Error

In this article

Back to top

Retrieves term parents with separator.

Parameters

$term_idintrequired
Term ID.
$taxonomystringrequired
Taxonomy name.
$argsstring|arrayoptional
Array of optional arguments.
  • format string
    Use term names or slugs for display. Accepts 'name' or 'slug'.
    Default 'name'.
  • separator string
    Separator for between the terms. Default '/'.
  • link bool
    Whether to format as a link. Default true.
  • inclusive bool
    Include the term to get the parents for. Default true.

Default:array()

Return

string|WP_Error A list of term parents on success, WP_Error or empty string on failure.

Source

function get_term_parents_list( $term_id, $taxonomy, $args = array() ) {
	$list = '';
	$term = get_term( $term_id, $taxonomy );

	if ( is_wp_error( $term ) ) {
		return $term;
	}

	if ( ! $term ) {
		return $list;
	}

	$term_id = $term->term_id;

	$defaults = array(
		'format'    => 'name',
		'separator' => '/',
		'link'      => true,
		'inclusive' => true,
	);

	$args = wp_parse_args( $args, $defaults );

	foreach ( array( 'link', 'inclusive' ) as $bool ) {
		$args[ $bool ] = wp_validate_boolean( $args[ $bool ] );
	}

	$parents = get_ancestors( $term_id, $taxonomy, 'taxonomy' );

	if ( $args['inclusive'] ) {
		array_unshift( $parents, $term_id );
	}

	foreach ( array_reverse( $parents ) as $term_id ) {
		$parent = get_term( $term_id, $taxonomy );
		$name   = ( 'slug' === $args['format'] ) ? $parent->slug : $parent->name;

		if ( $args['link'] ) {
			$list .= '<a href="' . esc_url( get_term_link( $parent->term_id, $taxonomy ) ) . '">' . $name . '</a>' . $args['separator'];
		} else {
			$list .= $name . $args['separator'];
		}
	}

	return $list;
}

View all references View on Trac View on GitHub

UsesDescription
wp_validate_boolean()wp-includes/functions.php

Filters/validates a variable as a boolean.

get_ancestors()wp-includes/taxonomy.php

Gets an array of ancestor IDs for a given object.

get_term_link()wp-includes/taxonomy.php

Generates a permalink for a taxonomy term archive.

esc_url()wp-includes/formatting.php

Checks and cleans a URL.

wp_parse_args()wp-includes/functions.php

Merges user defined arguments into defaults array.

get_term()wp-includes/taxonomy.php

Gets all term data from database by term ID.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 4 moreShow less
Used byDescription
get_category_parents()wp-includes/category-template.php

Retrieves category parents with separator.

Changelog

VersionDescription
4.8.0Introduced.

User Contributed Notes

  1. Skip to note 3 content
    keesiemeijer
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

    Example to display term parents in category archive pages. Use this in your category archive theme templates.

    <?php
if ( is_category() ) {
	// Get the current category term id.
	$query_obj = get_queried_object();
	$term_id   = $query_obj->term_id;

	echo get_term_parents_list( $term_id, 'category' );
}
?>

    This is an example of what it would print on a “Grandchild Category” term page.

    Parent Category/Child Category/Grandchild Category

  2. Skip to note 4 content
    keesiemeijer
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    Example of a breadcrumb trail for taxonomy pages. Use it in your theme’s taxonomy templates

    <?php
if ( ( is_tax() || is_category() || is_tag() ) ) {
	$trail     = '';
	$home      = '/<a href="' . get_home_url() . '">Home</a>';
	$query_obj = get_queried_object();
	$term_id   = $query_obj->term_id;
	$taxonomy  = get_taxonomy( $query_obj->taxonomy );

	if ( $term_id && $taxonomy ) {
		// Add taxonomy label name to the trail.
		$trail .=  '/' . $taxonomy->labels->menu_name;
		// Add term parents to the trail.
		$trail .= '/' . get_term_parents_list( $term_id, $taxonomy->name, array( 'inclusive' => false ) );
	}

	// Print trail and add current term name at the end.
	echo '<p class="breadcrumb-trail">' . $home . $trail . $query_obj->name . '</p>';
}
?>

You must log in before being able to contribute a note or feedback.