get_category_parents( int $category_id, bool $link = false, string $separator = '/', bool $nicename = false, array $deprecated = array() ): string|WP_Error
Retrieves category parents with separator.
Parameters
-
$category_idint Required -
Category ID.
-
$linkbool Optional -
Whether to format with link.
Default:
false -
$separatorstring Optional -
How to separate categories. Default
'/'.Default:
'/' -
$nicenamebool Optional -
Whether to use nice name for display.
Default:
false -
$deprecatedarray Optional -
Not used.
Default:
array()
Return
string|WP_Error A list of category parents on success, WP_Error on failure.
Source
File: wp-includes/category-template.php.
View all references
function get_category_parents( $category_id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {
if ( ! empty( $deprecated ) ) {
_deprecated_argument( __FUNCTION__, '4.8.0' );
}
$format = $nicename ? 'slug' : 'name';
$args = array(
'separator' => $separator,
'link' => $link,
'format' => $format,
);
return get_term_parents_list( $category_id, 'category', $args );
}
Changelog
| Version | Description |
|---|---|
| 4.8.0 | The $visited parameter was deprecated and renamed to $deprecated. |
| 1.2.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Note that
$nicenamereally means theslug. So if the$nicenameparameter is set totrue, the function will use the termslugfor display, and using the default value offalsewill use the human readable display name of the term.May be confusing at first, as some of us may think human readable names are nicer than slugs.
Basic Example
Returns the parent categories of the current category with links separated by ‘»’
will output: