Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
411 changes: 301 additions & 110 deletions bin/commands-manifest.json

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion commands/ability.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Lists, inspects, and executes abilities registered via the WordPress Abilities API.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

The Abilities API, introduced in WordPress 6.9, provides a standardized way to register and discover distinct units of functionality within a WordPress site.

### EXAMPLES
Expand All @@ -17,14 +19,15 @@ The Abilities API, introduced in WordPress 6.9, provides a standardized way to r
+---------------------------+----------------------+----------+------------------------------------------+

# Get details of a specific ability.
$ wp ability get core/get-site-info --fields=name,label,category,readonly,show_in_rest
$ wp ability get core/get-site-info --fields=name,label,category,readonly,public,show_in_rest
+---------------+----------------------+
| Field | Value |
+---------------+----------------------+
| name | core/get-site-info |
| label | Get Site Information |
| category | site |
| readonly | 1 |
| public | 1 |
| show_in_rest | 1 |
+---------------+----------------------+

Expand Down
2 changes: 2 additions & 0 deletions commands/ability/can-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Checks if the current user can execute an ability.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Validates permissions without actually executing the ability. Exits with return code 0 if permitted, 1 if not.

### OPTIONS
Expand Down
2 changes: 2 additions & 0 deletions commands/ability/category.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Lists and inspects ability categories registered via the WordPress Abilities API.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

The Abilities API, introduced in WordPress 6.9, uses categories to organize related abilities for better discoverability.

### EXAMPLES
Expand Down
2 changes: 2 additions & 0 deletions commands/ability/category/exists.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Checks whether an ability category is registered.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Exits with return code 0 if the category exists, 1 if it does not.

### OPTIONS
Expand Down
2 changes: 2 additions & 0 deletions commands/ability/category/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Gets details about a registered ability category.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/ability/category/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Lists all registered ability categories.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/ability/exists.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Checks whether an ability is registered.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Exits with return code 0 if the ability exists, 1 if it does not.

### OPTIONS
Expand Down
18 changes: 18 additions & 0 deletions commands/ability/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Gets details about a registered ability.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand All @@ -28,6 +30,8 @@ options:

### AVAILABLE FIELDS

These fields will be displayed by default:

* name
* label
* category
Expand All @@ -37,8 +41,17 @@ options:
* readonly
* destructive
* idempotent
* public
* show_in_rest

These fields are optionally available:

* meta

The `public` field reports the high-level client exposure flag as declared by the ability. As of WordPress 7.1 it seeds the default for channel-specific flags such as `show_in_rest`, which take precedence when set explicitly. On earlier versions the flag is stored but has no effect, so `public` and `show_in_rest` may disagree.

The `meta` field renders the raw metadata as JSON. It is the only way to inspect channel-specific settings registered by plugins, such as `mcp`.

### EXAMPLES

# Get details of a specific ability.
Expand All @@ -55,9 +68,14 @@ options:
| readonly | 1 |
| destructive | 0 |
| idempotent | 1 |
| public | 1 |
| show_in_rest | 1 |
+---------------+----------------------+

# Inspect channel-specific settings that have no field of their own.
$ wp ability get my-plugin/my-ability --field=meta
{"annotations":{"readonly":true,"destructive":false,"idempotent":null},"mcp":{"public":false},"show_in_rest":true,"public":true}

# Get ability as JSON.
$ wp ability get core/get-site-info --format=json

Expand Down
20 changes: 17 additions & 3 deletions commands/ability/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Lists all registered abilities.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand All @@ -12,8 +14,11 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg
[\--namespace=<prefix>]
: Filter abilities by namespace prefix (e.g., 'core' for 'core/*' abilities).

[\--show-in-rest=<bool>]
: Filter abilities by REST API exposure.
[\--public]
: Only list abilities flagged for client exposure. Pass --no-public to invert.

[\--show-in-rest]
: Only list abilities exposed to the REST API. Pass --no-show-in-rest to invert.

[\--field=<field>]
: Prints the value of a single field for each ability.
Expand Down Expand Up @@ -48,8 +53,11 @@ These fields are optionally available:
* readonly
* destructive
* idempotent
* public
* show_in_rest

The `public` field reports the high-level client exposure flag as declared by the ability. As of WordPress 7.1 it seeds the default for channel-specific flags such as `show_in_rest`, which take precedence when set explicitly. On earlier versions the flag is stored but has no effect, so `public` and `show_in_rest` may disagree.

### EXAMPLES

# List all abilities.
Expand All @@ -68,7 +76,13 @@ These fields are optionally available:
$ wp ability list --namespace=core

# List abilities exposed to REST API.
$ wp ability list --show-in-rest=true
$ wp ability list --show-in-rest

# List abilities meant to be available to clients.
$ wp ability list --public

# Find abilities that opt out of REST despite being public.
$ wp ability list --public --no-show-in-rest

# List abilities as JSON.
$ wp ability list --format=json
Expand Down
2 changes: 2 additions & 0 deletions commands/ability/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Executes a registered ability.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/ability/validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Validates input against an ability's schema.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Validates the input data without executing the ability. Useful for testing input before execution.

### OPTIONS
Expand Down
2 changes: 2 additions & 0 deletions commands/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Interacts with the WordPress AI Client for text and image generation.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### EXAMPLES

# Check AI capabilities status
Expand Down
2 changes: 2 additions & 0 deletions commands/ai/check.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Checks if a prompt is supported for generation.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/ai/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Generates AI content.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/ai/is-supported.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Checks whether AI features are supported in the current environment.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Exits with code 0 if AI features are supported, or code 1 if they are not.

### EXAMPLES
Expand Down
2 changes: 2 additions & 0 deletions commands/ai/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Checks which AI capabilities are currently supported.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Checks the environment and credentials to determine which AI operations are available. Displays a table showing supported capabilities.

### OPTIONS
Expand Down
2 changes: 2 additions & 0 deletions commands/block.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Manages WordPress block editor blocks and related entities.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### EXAMPLES

# List all registered block types
Expand Down
2 changes: 2 additions & 0 deletions commands/block/binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Retrieves details on registered block binding sources.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Get information on block binding sources from the WP_Block_Bindings_Registry. Block bindings allow dynamic data to be connected to block attributes.

### EXAMPLES
Expand Down
2 changes: 2 additions & 0 deletions commands/block/binding/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Gets details about a registered block binding source.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/block/binding/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Lists registered block binding sources.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/block/pattern-category.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Retrieves details on registered block pattern categories.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Get information on block pattern categories from the WP_Block_Pattern_Categories_Registry.

### EXAMPLES
Expand Down
2 changes: 2 additions & 0 deletions commands/block/pattern-category/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Gets details about a registered block pattern category.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/block/pattern-category/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Lists registered block pattern categories.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/block/pattern.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Retrieves details on registered block patterns.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Get information on WordPress' built-in and custom block patterns from the WP_Block_Patterns_Registry.

### EXAMPLES
Expand Down
2 changes: 2 additions & 0 deletions commands/block/pattern/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Gets details about a registered block pattern.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/block/pattern/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Lists registered block patterns.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/block/style.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Retrieves details on registered block styles.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Get information on block style variations from the WP_Block_Styles_Registry.

### EXAMPLES
Expand Down
2 changes: 2 additions & 0 deletions commands/block/style/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Gets details about a registered block style.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/block/style/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Lists registered block styles.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
2 changes: 2 additions & 0 deletions commands/block/synced-pattern.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Manages synced patterns (reusable blocks).

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

Synced patterns are stored as the 'wp_block' post type and can be either synced (changes reflect everywhere) or not synced (regular patterns).

### EXAMPLES
Expand Down
2 changes: 2 additions & 0 deletions commands/block/synced-pattern/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Creates a synced pattern.

> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough.

### OPTIONS

See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used.
Expand Down
Loading
Loading