get_cat_ID()
云策文档标注
概述
get_cat_ID() 函数用于根据分类名称获取其 ID，是 WordPress 分类操作中的基础工具。它通过调用 get_term_by() 实现，成功时返回分类 ID，失败时返回 0。
关键要点
- 参数：$cat_name（字符串，必需），指定分类名称。
- 返回值：成功时返回分类 ID（整数），分类不存在时返回 0。
- 内部实现：基于 get_term_by('name', $cat_name, 'category') 查询分类数据。
- 相关函数：与 get_term_by() 紧密关联，常用于 XML-RPC 接口如 mw_editPost() 和 mw_newPost()。
代码示例
$cat_id = get_cat_ID('Category Name');
if ($cat_id) {
echo 'Category ID: ' . $cat_id;
} else {
echo 'Category not found.';
}注意事项
- 函数名称不符合 WordPress 命名规范（如 PHPCS 忽略提示），但为向后兼容保留。
- 仅适用于“category”分类法，不适用于自定义分类法。
- 性能考虑：频繁调用可能影响效率，建议缓存结果或直接使用 get_term_by() 进行更复杂查询。
原文内容
Retrieves the ID of a category from its name.
Parameters
$cat_namestringrequired-
Category name.
Source
function get_cat_ID( $cat_name ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
$cat = get_term_by( 'name', $cat_name, 'category' );
if ( $cat ) {
return $cat->term_id;
}
return 0;
}
Changelog
| Version | Description |
|---|---|
| 1.0.0 | Introduced. |
Skip to note 3 content
hearvox
Example:
Skip to note 4 content
hearvox
Useful for a function such as
category_description()that requires a category’s ID:<p>The 'Category Name' description is: </p>