wp_register_ability_category() │ WP 6.9.0

Registers a new ability category in the Abilities API.

Categories group related abilities and must be registered before abilities that reference them.

Call this function only during the wp_abilities_api_categories_init action. Otherwise the category is not registered.

Uses: WP_Ability_Categories_Registry::get_instance(), WP_Ability_Categories_Registry::register()

Used By: wp_register_core_ability_categories()

No Hooks.

Returns

WP_Ability_Category|null.

WP_Ability_Category - the registered category.
null - if registration fails.

Usage

wp_register_ability_category( $slug, $args ): ?WP_Ability_Category;

$slug(string) (required): Unique category slug. Lowercase Latin letters, numbers, and single hyphens are allowed.
$args(array) (required): Category settings: label, description, and optional meta.

Examples

#1 Registration of the Opportunities category

add_action(
	'wp_abilities_api_categories_init',
	'my_plugin_register_ability_categories'
);

function my_plugin_register_ability_categories(): void {
	wp_register_ability_category(
		'content-management',
		[
			'label'       => __( 'Content Management', 'my-plugin' ),
			'description' => __( 'Abilities for managing content.', 'my-plugin' ),
		]
	);
}

Notes

See: WP_Ability_Categories_Registry::register()
See: wp_register_ability()
See: wp_unregister_ability_category()

Changelog

Since 6.9.0

Introduced.

`wp_register_ability_category() wp register ability category` code ^{WP 7.0.4}

wp-includes/abilities-api.php

function wp_register_ability_category( string $slug, array $args ): ?WP_Ability_Category {
	if ( ! doing_action( 'wp_abilities_api_categories_init' ) ) {
		_doing_it_wrong(
			__FUNCTION__,
			sprintf(
				/* translators: 1: wp_abilities_api_categories_init, 2: ability category slug. */
				__( 'Ability categories must be registered on the %1$s action. The ability category %2$s was not registered.' ),
				'<code>wp_abilities_api_categories_init</code>',
				'<code>' . esc_html( $slug ) . '</code>'
			),
			'6.9.0'
		);
		return null;
	}

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

	return $registry->register( $slug, $args );
}