函数文档

get_the_category_by_ID()

💡 云策文档标注

概述

get_the_category_by_ID() 函数用于根据分类 ID 检索分类名称,返回字符串或 WP_Error 对象。

关键要点

  • 参数:$cat_id(int,必需),表示分类 ID。
  • 返回值:成功时返回分类名称(字符串),失败时返回 WP_Error。
  • 内部实现:使用 get_term() 获取分类数据,并通过 is_wp_error() 检查错误。
  • 相关函数:get_term() 用于从数据库获取分类数据,is_wp_error() 用于错误检查。
  • 历史版本:自 WordPress 0.71 版本引入。

代码示例

function get_the_category_by_ID( $cat_id ) {
    $cat_id   = (int) $cat_id;
    $category = get_term( $cat_id );

    if ( is_wp_error( $category ) ) {
        return $category;
    }

    return ( $category ) ? $category->name : '';
}

📄 原文内容

Retrieves category name based on category ID.

Parameters

$cat_idintrequired
Category ID.

Return

string|WP_Error Category name on success, WP_Error on failure.

Source

function get_the_category_by_ID( $cat_id ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
	$cat_id   = (int) $cat_id;
	$category = get_term( $cat_id );

	if ( is_wp_error( $category ) ) {
		return $category;
	}

	return ( $category ) ? $category->name : '';
}

Changelog

Version Description
0.71 Introduced.

User Contributed Notes