wp_get_ability( string $name ): WP_Ability|null

Retrieves a registered ability.

Description

Returns the ability instance for inspection or use. The instance provides access to the ability’s configuration, metadata, and execution methods.

Example:

// Prints information about a registered ability.
$ability = wp_get_ability( 'my-plugin/export-data' );
if ( $ability ) {
    echo $ability->get_label() . ': ' . $ability->get_description();
}

Parameters

$namestringrequired: The name of the ability, including namespace prefix (e.g., 'my-plugin/my-ability').

Return

WP_Ability|null The registered ability instance, or null if not registered.

Source

function wp_get_ability( string $name ): ?WP_Ability {
	$registry = WP_Abilities_Registry::get_instance();
	if ( null === $registry ) {
		return null;
	}

	return $registry->get_registered( $name );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Abilities_Registry::get_instance()`wp-includes/abilities-api/class-wp-abilities-registry.php`	Utility method to retrieve the main instance of the registry class.

Used by	Description
WP_REST_Abilities_V1_Run_Controller::execute_ability()`wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-run-controller.php`	Executes an ability.
WP_REST_Abilities_V1_Run_Controller::check_ability_permissions()`wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-run-controller.php`	Checks if a given request has permission to execute a specific ability.
WP_REST_Abilities_V1_List_Controller::get_item()`wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-list-controller.php`	Retrieves a specific ability.

Changelog

Version	Description
6.9.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.