wp_get_ability_category()
云策文档标注
概述
wp_get_ability_category() 函数用于检索已注册的能力类别实例，返回 WP_Ability_Category 对象或 null。该函数通过 WP_Ability_Categories_Registry 获取实例，适用于 WordPress 开发者检查和利用能力类别的配置与元数据。
关键要点
- 函数接受一个必需的字符串参数 $slug，表示能力类别的标识符。
- 返回类型为 WP_Ability_Category 或 null，若类别未注册则返回 null。
- 函数内部调用 WP_Ability_Categories_Registry::get_instance() 获取注册表实例，再通过 get_registered() 方法检索。
- 相关函数包括 wp_has_ability_category() 和 wp_get_ability_categories()，用于检查存在性和获取所有类别。
代码示例
// 打印已注册能力类别的信息。
$ability_category = wp_get_ability_category( 'content-management' );
if ( $ability_category ) {
echo $ability_category->get_label() . ': ' . $ability_category->get_description();
}注意事项
- 该函数在 WordPress 6.9.0 版本中引入，使用时需确保版本兼容性。
- 调用前应检查返回值是否为 null，以避免未注册类别导致的错误。
原文内容
Retrieves a registered ability category.
Description
Returns the ability category instance for inspection or use. The instance provides access to the ability category’s configuration and metadata.
Example:
// Prints information about a registered ability category.
$ability_category = wp_get_ability_category( 'content-management' );
if ( $ability_category ) {
echo $ability_category->get_label() . ': ' . $ability_category->get_description();
}See also
Parameters
$slugstringrequired-
The slug of the ability category.
Source
function wp_get_ability_category( string $slug ): ?WP_Ability_Category {
$registry = WP_Ability_Categories_Registry::get_instance();
if ( null === $registry ) {
return null;
}
return $registry->get_registered( $slug );
}
Changelog
| Version | Description |
|---|---|
| 6.9.0 | Introduced. |