WordPress开发手册:get_term_parents_list()

函数原型

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

函数描述

是否弃用

未弃用

函数参数

$term_id
int
Required

Term ID.

$taxonomy
string
Required

Taxonomy name.

$args
string|array
Optional

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()

函数返回值

函数位置

函数源码

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

源码链接

WordPress
Github

变更日志