get_category_parents( int $category_id, bool $link = false, string $separator = '/', bool $nicename = false, array $deprecated = array() ): string|WP_Error

Parameters

$category_idint

Category ID.

$linkbooloptional

Whether to format with link. Default false.Default: false

$separatorstringoptional

How to separate categories. Default '/'.Default: '/'

$nicenamebooloptional

Whether to use nice name for display. Default false.Default: false

$deprecatedarrayoptional

Not used.Default: array()

Return

string|WP_Error

A list of category parents on success, WP_Error on failure.

Uses · 2

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• get_term_parents_list()Retrieves term parents with separator.

Used by · 2

• get_permalink()Retrieves the full permalink for the current post or post ID.
• get_the_category_list()Retrieves category list for a post in either HTML list or custom format.

Source

View on Trac ↗View on GitHub ↗

47function get_category_parents( $category_id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {48 49	if ( ! empty( $deprecated ) ) {50		_deprecated_argument( __FUNCTION__, '4.8.0' );51	}52 53	$format = $nicename ? 'slug' : 'name';54 55	$args = array(56		'separator' => $separator,57		'link'      => $link,58		'format'    => $format,59	);60 61	return get_term_parents_list( $category_id, 'category', $args );62}

History

Introduced in 1.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/category-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.