wp ability get

Options

<name>

The ability name (namespace/ability-name format).

[--field=<field>]

Instead of returning the whole ability, returns the value of a single field.

[--fields=<fields>]

Limit the output to specific fields. Defaults to all fields.

[--format=<format>]

Render output in a particular format.
—
default: table
options:
– table
– csv
– json
– yaml
—

Available Fields

• name
• label
• category
• description
• input_schema
• output_schema
• readonly
• destructive
• idempotent
• show_in_rest

Examples

# Get details of a specific ability.
$ wp ability get core/get-site-info
+---------------+----------------------+
| Field         | Value                |
+---------------+----------------------+
| name          | core/get-site-info   |
| label         | Get Site Information |
| category      | site                 |
| description   | Returns site info... |
| input_schema  | {"type":"object"}    |
| output_schema | {"type":"object"}    |
| readonly      | 1                    |
| destructive   | 0                    |
| idempotent    | 1                    |
| show_in_rest  | 1                    |
+---------------+----------------------+
# Get ability as JSON.
$ wp ability get core/get-site-info --format=json
# Get only the description.
$ wp ability get core/get-site-info --field=description
Returns site information configured in WordPress.

Global Parameters