云策 WordPress 开发者社区

函数文档

get_category_parents()

查看官方原文 ↗
💡 云策文档标注

概述

get_category_parents() 函数用于检索指定分类的父级分类列表，并可选择性地以链接形式格式化输出。该函数内部调用 get_term_parents_list() 实现核心功能，并包含参数处理逻辑。

关键要点

  • 函数参数包括：$category_id（必需，分类ID）、$link（可选，是否格式化为链接，默认false）、$separator（可选，分隔符，默认'/'）、$nicename（可选，是否使用slug显示，默认false）、$deprecated（可选，已弃用参数，默认空数组）。
  • 返回值：成功时返回父级分类字符串，失败时返回 WP_Error 对象。
  • 自版本4.8.0起，$visited 参数已弃用并重命名为 $deprecated。
  • 注意 $nicename 参数实际控制使用 term slug（true）或可读名称（false）进行显示，这可能与直觉相反。

代码示例

// 基本示例：返回当前分类的父级分类，以链接和'»'分隔符格式
// 输出示例：Internet » Blogging » WordPress »
📄 原文内容

Retrieves category parents with separator.

Parameters

$category_idintrequired
Category ID.
$linkbooloptional
Whether to format with link.

Default:false

$separatorstringoptional
How to separate categories. Default '/'.
$nicenamebooloptional
Whether to use nice name for display.

Default:false

$deprecatedarrayoptional
Not used.

Default:array()

Return

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

Source

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

View all references View on Trac View on GitHub

Uses Description
get_term_parents_list()wp-includes/category-template.php

Retrieves term parents with separator.
_deprecated_argument()wp-includes/functions.php

Marks a function argument as deprecated and inform when it has been used.
Used by Description
get_the_category_list()wp-includes/category-template.php

Retrieves category list for a post in either HTML list or custom format.
get_permalink()wp-includes/link-template.php

Retrieves the full permalink for the current post or post ID.

Changelog

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

User Contributed Notes

  1. Skip to note 3 content


    Bence Szalai


    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    Note that $nicename really means the slug. So if the $nicename parameter is set to true, the function will use the term slug for display, and using the default value of false will 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.