wpseek.com
A WordPress-centric search engine for devs and theme authors



get_term_parents_list › WordPress Function

Since4.8.0
Deprecatedn/a
› get_term_parents_list ( $term_id, $taxonomy, $args = array() )
Parameters: (3)
  • (int) $term_id Term ID.
    Required: Yes
  • (string) $taxonomy Taxonomy name.
    Required: Yes
  • (string|array) $args { Array of optional arguments. @type string $format Use term names or slugs for display. Accepts 'name' or 'slug'. Default 'name'. @type string $separator Separator for between the terms. Default '/'. @type bool $link Whether to format as a link. Default true. @type bool $inclusive Include the term to get the parents for. Default true. }
    Required: No
    Default: array()
Returns:
  • (string|WP_Error) A list of term parents on success, WP_Error or empty string on failure.
Defined at:
Codex:

Retrieves term parents with separator.



Related Functions: get_theme_feature_list, get_category_parents, get_the_tag_list, get_term_to_edit, get_the_term_list

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;
}