云策 WordPress 开发者社区

函数文档

get_cat_name()

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

概述

get_cat_name() 函数用于根据分类 ID 检索分类名称。它通过 get_term() 获取分类数据，并在分类不存在或出错时返回空字符串。

关键要点

  • 参数：$cat_id（int，必需），表示分类 ID。
  • 返回值：string，分类名称；若分类不存在则返回空字符串。
  • 内部实现：使用 get_term() 查询分类数据，并检查是否为 WP_Error。
  • 相关函数：get_term()、is_wp_error()，以及一些已弃用或 XML-RPC 相关函数。
  • 版本历史：自 WordPress 1.0.0 引入。

代码示例

function get_cat_name( $cat_id ) {
    $cat_id   = (int) $cat_id;
    $category = get_term( $cat_id, 'category' );

    if ( ! $category || is_wp_error( $category ) ) {
        return '';
    }

    return $category->name;
}
📄 原文内容

Retrieves the name of a category from its ID.

Parameters

$cat_idintrequired
Category ID.

Return

string Category name, or an empty string if the category doesn’t exist.

Source

function get_cat_name( $cat_id ) {
	$cat_id   = (int) $cat_id;
	$category = get_term( $cat_id, 'category' );

	if ( ! $category || is_wp_error( $category ) ) {
		return '';
	}

	return $category->name;
}

View all references View on Trac View on GitHub

Uses Description
get_term()wp-includes/taxonomy.php

Gets all term data from database by term ID.
is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.
Used by Description
get_catname()wp-includes/deprecated.php

Retrieve the category name by the category ID.
wp_xmlrpc_server::mt_getPostCategories()wp-includes/class-wp-xmlrpc-server.php

Retrieves post categories.
wp_xmlrpc_server::mw_getPost()wp-includes/class-wp-xmlrpc-server.php

Retrieves a post.
wp_xmlrpc_server::mw_getRecentPosts()wp-includes/class-wp-xmlrpc-server.php

Retrieves list of recent posts.
wp_xmlrpc_server::_prepare_page()wp-includes/class-wp-xmlrpc-server.php

Prepares page data for return in an XML-RPC object.

Changelog

Version Description
1.0.0 Introduced.

User Contributed Notes