Skip to content

Developer.wordpress.org updates #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathanbossenger wants to merge 4 commits into
base: trunk
Choose a base branch
from
Open

Developer.wordpress.org updates #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d154fc
Adds details about DELETE requests (#152)
jonathanbossenger Nov 28, 2025
c36c89a
Merge branch 'trunk' of github.com:WordPress/abilities-api into trunk
jonathanbossenger Nov 28, 2025
b141147
Updates for developer.wordpress.org
jonathanbossenger Dec 22, 2025
e2afded
Fixing syntax error reported https://github.com/WordPress/Documentati…
jonathanbossenger Dec 22, 2025
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
34 changes: 17 additions & 17 deletions docs/hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,21 @@ do_action( 'wp_abilities_api_categories_init', $registry );
#### Usage Example

```php
add_action( 'wp_abilities_api_categories_init', 'my_plugin_register_categories' );
add_action( 'wp_abilities_api_categories_init', 'wporg_register_categories' );
/**
* Register custom ability categories.
*
* @param \WP_Ability_Categories_Registry $registry The category registry instance.
*/
function my_plugin_register_categories( $registry ) {
function wporg_register_categories( $registry ) {
wp_register_ability_category( 'ecommerce', array(
'label' => __( 'E-commerce', 'my-plugin' ),
'description' => __( 'Abilities related to e-commerce functionality.', 'my-plugin' ),
'label' => __( 'E-commerce', 'textdomain' ),
'description' => __( 'Abilities related to e-commerce functionality.', 'textdomain' ),
));

wp_register_ability_category( 'analytics', array(
'label' => __( 'Analytics', 'my-plugin' ),
'description' => __( 'Abilities that provide analytical data and insights.', 'my-plugin' ),
'label' => __( 'Analytics', 'textdomain' ),
'description' => __( 'Abilities that provide analytical data and insights.', 'textdomain' ),
));
}
```
Expand All @@ -64,14 +64,14 @@ do_action( 'wp_abilities_api_init', $registry );
#### Usage Example

```php
add_action('wp_abilities_api_init', 'my_plugin_register_abilities');
add_action('wp_abilities_api_init', 'wporg_register_abilities');
/**
* Register custom abilities.
*/
function my_plugin_register_abilities() {
wp_register_ability( 'my-plugin/ability', array(
'label' => __( 'Title', 'my-plugin' ),
'description' => __( 'Description.', 'my-plugin' ),
function wporg_register_abilities() {
wp_register_ability( 'wporg/ability', array(
'label' => __( 'Title', 'textdomain' ),
'description' => __( 'Description.', 'textdomain' ),
'category' => 'analytics',
'input_schema' => array(
'type' => 'object',
Expand All @@ -82,7 +82,7 @@ function my_plugin_register_abilities() {
'type' => 'string',
'description' => 'The site title.',
),
'execute_callback' => 'my_plugin_get_site_title',
'execute_callback' => 'wporg_get_site_title',
'permission_callback' => '__return_true', // Everyone can access this
'meta' => array(
'show_in_rest' => true, // Optional: expose via REST API
Expand All @@ -100,7 +100,7 @@ do_action( 'wp_before_execute_ability', $ability_name, $input );

#### Parameters

- `$ability_name` (`string`): The namespaced name of the ability being executed (e.g., `my-plugin/get-posts`).
- `$ability_name` (`string`): The namespaced name of the ability being executed (e.g., `wporg/get-posts`).
- `$input` (`mixed`): The input data passed to the ability.

#### Usage Example
Expand Down Expand Up @@ -164,7 +164,7 @@ $args = apply_filters( 'wp_register_ability_args', array $args, string $ability_
#### Parameters

- `$args` (`array<string,mixed>`): The arguments used to instantiate the ability. See [wp_register_ability()](./3.registering-abilities.md#wp_register_ability) for the full list of args.
- `$ability_name` (`string`): The namespaced name of the ability being registered (e.g., `my-plugin/get-posts`).
- `$ability_name` (`string`): The namespaced name of the ability being registered (e.g., `wporg/get-posts`).

#### Usage Example

Expand Down Expand Up @@ -205,7 +205,7 @@ function my_modify_ability_args( array $args, string $ability_name ): array {
}

return current_user_can( 'my_custom_ability_cap', $ability_name );
}
};

return $args;
}
Expand Down Expand Up @@ -238,8 +238,8 @@ add_filter( 'wp_register_ability_category_args', 'my_modify_category_args', 10,
*/
function my_modify_category_args( array $args, string $slug ): array {
if ( 'my-category' === $slug ) {
$args['label'] = __( 'My Custom Label', 'my-plugin' );
$args['description'] = __( 'My custom description for this category.', 'my-plugin' );
$args['label'] = __( 'My Custom Label', 'textdomain' );
$args['description'] = __( 'My custom description for this category.', 'textdomain' );
}
return $args;
}
Expand Down
Loading