Taxonomy: Introduce `get_term_parents_list()`.
This new function is a taxonomy-agnostic version of `get_category_parents()`. Props keesiemeijer, SergeyBiryukov, rafaehlers. Fixes #17069. Built from https://develop.svn.wordpress.org/trunk@39549 git-svn-id: http://core.svn.wordpress.org/trunk@39489 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
d94530e721
commit
74b6e1ba86
|
@ -32,35 +32,30 @@ function get_category_link( $category ) {
|
|||
* Retrieve category parents with separator.
|
||||
*
|
||||
* @since 1.2.0
|
||||
* @since 4.8.0 The `$visited` parameter was deprecated and renamed to `$deprecated`.
|
||||
*
|
||||
* @param int $id Category ID.
|
||||
* @param bool $link Optional, default is false. Whether to format with link.
|
||||
* @param string $separator Optional, default is '/'. How to separate categories.
|
||||
* @param bool $nicename Optional, default is false. Whether to use nice name for display.
|
||||
* @param array $visited Optional. Already linked to categories to prevent duplicates.
|
||||
* @param array $deprecated Not used.
|
||||
* @return string|WP_Error A list of category parents on success, WP_Error on failure.
|
||||
*/
|
||||
function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $visited = array() ) {
|
||||
$chain = '';
|
||||
$parent = get_term( $id, 'category' );
|
||||
if ( is_wp_error( $parent ) )
|
||||
return $parent;
|
||||
function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {
|
||||
|
||||
if ( $nicename )
|
||||
$name = $parent->slug;
|
||||
else
|
||||
$name = $parent->name;
|
||||
|
||||
if ( $parent->parent && ( $parent->parent != $parent->term_id ) && !in_array( $parent->parent, $visited ) ) {
|
||||
$visited[] = $parent->parent;
|
||||
$chain .= get_category_parents( $parent->parent, $link, $separator, $nicename, $visited );
|
||||
if ( ! empty( $deprecated ) ) {
|
||||
_deprecated_argument( __FUNCTION__, '4.8.0' );
|
||||
}
|
||||
|
||||
if ( $link )
|
||||
$chain .= '<a href="' . esc_url( get_category_link( $parent->term_id ) ) . '">'.$name.'</a>' . $separator;
|
||||
else
|
||||
$chain .= $name.$separator;
|
||||
return $chain;
|
||||
$format = $nicename ? 'slug' : 'name';
|
||||
|
||||
$args = array(
|
||||
'separator' => $separator,
|
||||
'link' => $link,
|
||||
'format' => $format,
|
||||
);
|
||||
|
||||
return get_term_parents_list( $id, 'category', $args );
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -1232,6 +1227,71 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = ''
|
|||
return $before . join( $sep, $term_links ) . $after;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve term parents with separator.
|
||||
*
|
||||
* @since 4.8.0
|
||||
*
|
||||
* @param int $term_id Term ID.
|
||||
* @param string $taxonomy Taxonomy name.
|
||||
* @param 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.
|
||||
* }
|
||||
* @return string|WP_Error A list of term parents on success, WP_Error or empty string on failure.
|
||||
*/
|
||||
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_category_link( $parent->term_id ) ) . '">' . $name . '</a>' . $args['separator'];
|
||||
} else {
|
||||
$list .= $name . $args['separator'];
|
||||
}
|
||||
}
|
||||
|
||||
return $list;
|
||||
}
|
||||
|
||||
/**
|
||||
* Display the terms in a list.
|
||||
*
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '4.8-alpha-39548';
|
||||
$wp_version = '4.8-alpha-39549';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
Loading…
Reference in New Issue