函数文档

wp_get_ability_categories()

💡 云策文档标注

概述

wp_get_ability_categories() 函数用于检索系统中所有已注册的 ability categories。它返回一个包含 WP_Ability_Category 实例的数组,适用于发现、调试或构建管理界面。

关键要点

  • 函数返回所有已注册 ability category 实例的数组,若无注册或注册表不可用则返回空数组。
  • 内部通过 WP_Ability_Categories_Registry::get_instance() 获取注册表实例,并调用 get_all_registered() 方法。
  • 自 WordPress 6.9.0 版本引入。

代码示例

// 打印所有可用 ability categories 的信息。
$ability_categories = wp_get_ability_categories();
foreach ( $ability_categories as $ability_category ) {
    echo $ability_category->get_label() . ': ' . $ability_category->get_description() . "n";
}

注意事项

  • 相关函数包括 WP_Ability_Categories_Registry::get_all_registered() 和 wp_get_ability_category()。
  • 在 REST API 中,WP_REST_Abilities_V1_Categories_Controller::get_items() 使用此函数检索 ability categories。

📄 原文内容

Retrieves all registered ability categories.

Description

Returns an array of all ability category instances currently registered in the system.
Use this for discovery, debugging, or building administrative interfaces.

Example:

// Prints information about all available ability categories.
$ability_categories = wp_get_ability_categories();
foreach ( $ability_categories as $ability_category ) {
    echo $ability_category->get_label() . ': ' . $ability_category->get_description() . "n";
}

See also

Return

WP_Ability_Category[] An array of registered ability category instances. Returns an empty array if no ability categories are registered or if the registry is unavailable.

Source

function wp_get_ability_categories(): array {
	$registry = WP_Ability_Categories_Registry::get_instance();
	if ( null === $registry ) {
		return array();
	}

	return $registry->get_all_registered();
}

Changelog

Version Description
6.9.0 Introduced.