wp ability run

Options

<name>

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

[--input=<json>]

JSON string containing input data for the ability. Use ‘-‘ to read from stdin.

[--<field>=<value>]

Individual input fields. Alternative to –input for simple inputs.

[--format=<format>]

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

Examples

# Execute an ability.
$ wp ability run core/get-site-info --user=admin
{
    "name": "Test Blog",
    "description": "Just another WordPress site",
    "url": "https://example.com",
    ...
}
# Execute an ability with JSON input (required for array values).
$ wp ability run core/get-site-info --input='{"fields":["name","version"]}' --user=admin
{
    "name": "Test Blog",
    "version": "6.9"
}
# Execute an ability with simple string arguments.
$ wp ability run my-plugin/greet --name=World
# Execute and output as YAML.
$ wp ability run core/get-site-info --format=yaml --user=admin
name: Test Blog
description: Just another WordPress site
...
# Execute with input from stdin.
$ echo '{"fields":["name"]}' | wp ability run core/get-site-info --input=- --user=admin

Global Parameters