wp_register_ability_category( string $slug, array $args ): WP_Ability_Category|null

Description

function my_plugin_register_categories() {
 wp_register_ability_category(
 'content-management',
 array(
 'label' => __( 'Content Management', 'my-plugin' ),
 'description' => __( 'Abilities for managing and organizing content.', 'my-plugin' ),
 )
 );
}
add_action( 'wp_abilities_api_categories_init', 'my_plugin_register_categories' );

Compatibility

Present in 3 of the 5 tracked releases, added in 6.9.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$slugstring

The unique slug for the ability category. Must contain only lowercase alphanumeric characters and dashes (e.g., 'data-export').

$argsarray

Return value

WP_Ability_Category|null

The registered ability category instance on success, null on failure.

Performance profile

How much work a call to wp_register_ability_category() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

12–25

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 37.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()one call below wp_register_ability_category()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_register_ability_category() can have, taken from its control-flow graph on PHP 8.5.

Uses · 5

• doing_action()Returns whether or not an action hook is currently being processed.
• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• esc_html()Escaping for HTML blocks.
• WP_Ability_Categories_Registry::get_instance()Utility method to retrieve the main instance of the registry class.

Used by · 1

• wp_register_core_ability_categories()Registers the core ability categories.

Source code

View on Trac ↗View on GitHub ↗

645function wp_register_ability_category( string $slug, array $args ): ?WP_Ability_Category {646	if ( ! doing_action( 'wp_abilities_api_categories_init' ) ) {647		_doing_it_wrong(648			__FUNCTION__,649			sprintf(650				/* translators: 1: wp_abilities_api_categories_init, 2: ability category slug. */651				__( 'Ability categories must be registered on the %1$s action. The ability category %2$s was not registered.' ),652				'<code>wp_abilities_api_categories_init</code>',653				'<code>' . esc_html( $slug ) . '</code>'654			),655			'6.9.0'656		);657		return null;658	}659 660	$registry = WP_Ability_Categories_Registry::get_instance();661	if ( null === $registry ) {662		return null;663	}664 665	return $registry->register( $slug, $args );666}

Changelog

Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.

1. 6.9.7
2. 7.0.4
3. 7.1.0

Signature, return type and hooks compared across 3 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/abilities-api.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.