Skip to content

Docs: Fix malformed nested DocBlock types for wp_register_ability() #11745

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
crmv1 wants to merge 1 commit into
base: trunk
Choose a base branch
from
+10 −17
Open

Docs: Fix malformed nested DocBlock types for wp_register_ability() #11745

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
27 changes: 10 additions & 17 deletions src/wp-includes/abilities-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,23 +251,16 @@
* @type array<string, mixed> $output_schema Optional. JSON Schema definition for the ability's output.
* Describes the structure of successful return values from
* `execute_callback`. Used for documentation and validation.
* @type array<string, mixed> $meta {
* Optional. Additional metadata for the ability.
*
* @type array<string, bool|null> $annotations {
* Optional. Semantic annotations describing the ability's behavioral characteristics.
* These annotations are hints for tooling and documentation.
*
* @type bool|null $readonly Optional. If true, the ability does not modify its environment.
* @type bool|null $destructive Optional. If true, the ability may perform destructive updates to its environment.
* If false, the ability performs only additive updates.
* @type bool|null $idempotent Optional. If true, calling the ability repeatedly with the same arguments
* will have no additional effect on its environment.
* }
* @type bool $show_in_rest Optional. Whether to expose this ability in the REST API.
* When true, the ability can be invoked via HTTP requests.
* Default false.
* }
* @type array<string, mixed> $meta Optional. Additional metadata for the ability.
* @type array<string, bool|null> $annotations Optional. Semantic annotations describing the ability's behavioral
* characteristics. These annotations are hints for tooling and documentation.
* @type bool|null $readonly Optional. If true, the ability does not modify its environment.
* @type bool|null $destructive Optional. If true, the ability may perform destructive updates to its
* environment. If false, the ability performs only additive updates.
* @type bool|null $idempotent Optional. If true, calling the ability repeatedly with the same arguments
* will have no additional effect on its environment.
* @type bool $show_in_rest Optional. Whether to expose this ability in the REST API. When true,
* the ability can be invoked via HTTP requests. Default false.
* @type string $ability_class Optional. Fully-qualified custom class name to instantiate
* instead of the default `WP_Ability` class. The custom class
* must extend `WP_Ability`. Useful for advanced customization
Expand Down
Loading