Skip to content
This repository was archived by the owner on Feb 5, 2026. It is now read-only.

Updated Inline Documentation Order #57

Merged
gziolo merged 1 commit into from
Sep 4, 2025
Merged

Updated Inline Documentation Order #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions includes/abilities-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
*
* Note: Do not use before the {@see 'abilities_api_init'} hook.
*
* @see WP_Abilities_Registry::register()
*
* @since 0.1.0
*
* @see WP_Abilities_Registry::register()
*
* @param string $name The name of the ability. The name must be a string containing a namespace
* prefix, i.e. `my-plugin/my-ability`. It can only contain lowercase
* alphanumeric characters, dashes and the forward slash.
Expand Down Expand Up @@ -63,10 +63,10 @@ function wp_register_ability( string $name, array $properties = array() ): ?WP_A
/**
* Unregisters an ability using Abilities API.
*
* @see WP_Abilities_Registry::unregister()
*
* @since 0.1.0
*
* @see WP_Abilities_Registry::unregister()
*
* @param string $name The name of the registered ability, with its namespace.
* @return ?\WP_Ability The unregistered ability instance on success, null on failure.
*/
Expand All @@ -77,10 +77,10 @@ function wp_unregister_ability( string $name ): ?WP_Ability {
/**
* Retrieves a registered ability using Abilities API.
*
* @see WP_Abilities_Registry::get_registered()
*
* @since 0.1.0
*
* @see WP_Abilities_Registry::get_registered()
*
* @param string $name The name of the registered ability, with its namespace.
* @return ?\WP_Ability The registered ability instance, or null if it is not registered.
*/
Expand All @@ -91,10 +91,10 @@ function wp_get_ability( string $name ): ?WP_Ability {
/**
* Retrieves all registered abilities using Abilities API.
*
* @see WP_Abilities_Registry::get_all_registered()
*
* @since 0.1.0
*
* @see WP_Abilities_Registry::get_all_registered()
*
* @return \WP_Ability[] The array of registered abilities.
*/
function wp_get_abilities(): array {
Expand Down