[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> abilities-api.php (summary)

Abilities API Defines functions for managing abilities in WordPress.

File Size: 260 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 10 functions

  wp_register_ability()
  wp_unregister_ability()
  wp_has_ability()
  wp_get_ability()
  wp_get_abilities()
  wp_register_ability_category()
  wp_unregister_ability_category()
  wp_has_ability_category()
  wp_get_ability_category()
  wp_get_ability_categories()

Functions
Functions that are not part of a class:

wp_register_ability( string $name, array $args )   X-Ref
Registers a new ability using Abilities API.

Note: Should only be used on the {@see 'wp_abilities_api_init'} hook.

return: WP_Ability|null An instance of registered ability on success, null on failure.
param: string               $name The name of the ability. The name must be a string containing a namespace
param: array<string, mixed> $args {

wp_unregister_ability( string $name )   X-Ref
Unregisters an ability from the Abilities API.

return: WP_Ability|null The unregistered ability instance on success, null on failure.
param: string $name The name of the registered ability, with its namespace.

wp_has_ability( string $name )   X-Ref
Checks if an ability is registered.

return: bool True if the ability is registered, false otherwise.
param: string $name The name of the registered ability, with its namespace.

wp_get_ability( string $name )   X-Ref
Retrieves a registered ability using Abilities API.

return: WP_Ability|null The registered ability instance, or null if it is not registered.
param: string $name The name of the registered ability, with its namespace.

wp_get_abilities()   X-Ref
Retrieves all registered abilities using Abilities API.

return: WP_Ability[] The array of registered abilities.

wp_register_ability_category( string $slug, array $args )   X-Ref
Registers a new ability category.

return: WP_Ability_Category|null The registered ability category instance on success, null on failure.
param: string               $slug The unique slug for the ability category. Must contain only lowercase
param: array<string, mixed> $args {

wp_unregister_ability_category( string $slug )   X-Ref
Unregisters an ability category.

return: WP_Ability_Category|null The unregistered ability category instance on success, null on failure.
param: string $slug The slug of the registered ability category.

wp_has_ability_category( string $slug )   X-Ref
Checks if an ability category is registered.

return: bool True if the ability category is registered, false otherwise.
param: string $slug The slug of the ability category.

wp_get_ability_category( string $slug )   X-Ref
Retrieves a registered ability category.

return: WP_Ability_Category|null The registered ability category instance, or null if it is not registered.
param: string $slug The slug of the registered ability category.

wp_get_ability_categories()   X-Ref
Retrieves all registered ability categories.

return: WP_Ability_Category[] The array of registered ability categories.



Generated : Thu Oct 23 08:20:05 2025 Cross-referenced by PHPXref