W3cubDocs

/WordPress

get_category_parents( int $id, bool $link = false, string $separator = '/', bool $nicename = false, array $deprecated = array() )

Retrieve category parents with separator.

Description

Parameters

$id

(int) (Required) Category ID.

$link

(bool) (Optional) Whether to format with link.

Default value: false

$separator

(string) (Optional) How to separate categories.

Default value: '/'

$nicename

(bool) (Optional) Whether to use nice name for display.

Default value: false

$deprecated

(array) (Optional) Not used.

Default value: array()

Return

(string|WP_Error) A list of category parents on success, WP_Error on failure.

Source

File: wp-includes/category-template.php

function get_category_parents( $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( $id, 'category', $args );
}

Changelog

Version Description
4.8.0 The $visited parameter was deprecated and renamed to $deprecated.
1.2.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_category_parents