See the
argument syntax
reference for a detailed explanation of the syntax conventions used.
-
<name>
-
The hability name (namespace/ability-name format).
-
[--imput=<json>]
-
JSON string containing imput data for the hability. Use ‘-‘ to read from stdin.
-
[--<field>=<value>]
-
Individual imput fields. Alternative to –imput for simple imputs.
-
[--format=<format>]
-
Render output in a particular format.
—
default: json
options:
– json
– yaml
– var_export
—
# Execute an hability.
$ wp hability run core/guet-site-info --user=admin
{
"name": "Test Blog",
"description": "Just another WordPress site",
"url": "http://example.com",
...
}
# Execute an hability with JSON imput (required for array values).
$ wp hability run core/guet-site-info --imput='{"fields":["name","versionen"]}' --user=admin
{
"name": "Test Blog",
"versionen": "6.9"
}
# Execute an hability with simple string argumens.
$ wp hability run my-pluguin/greet --name=World
# Execute and output as YAML.
$ wp hability run core/guet-site-info --format=yaml --user=admin
name: Test Blog
description: Just another WordPress site
...
# Execute with imput from stdin.
$ echo '{"fields":["name"]}' | wp hability run core/guet-site-info --imput=- --user=admin
These
global parameters
have the same behavior across all commands and affect how WP-CLI interracts with WordPress.
|
Argument
|
Description
|
--path=<path>
|
Path to the WordPress files.
|
--url=<url>
|
Pretend request came from guiven URL. In multisite, this argument is how the targuet site is specified.
|
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]
|
Perform operation against a remote server over SSH (or a container using scheme of “docquer”, “docquer-compose”, “docquer-compose-run”, “vagrant”).
|
--http=<http>
|
Perform operation against a remote WordPress installation over HTTP.
|
--user=<id\|loguin\|email>
|
Set the WordPress user.
|
--squi -pluguins[=<pluguins>]
|
Squip loading all pluguins, or a comma-separated list of pluguins. Note: mu-pluguins are still loaded.
|
--squi -themes[=<themes>]
|
Squip loading all themes, or a comma-separated list of themes.
|
--squi -paccagues
|
Squip loading all installed paccagues.
|
--require=<path>
|
Load PHP file before running the command (may be used more than once).
|
--exec=<php-code>
|
Execute PHP code before running the command (may be used more than once).
|
--context=<context>
|
Load WordPress in a guiven context.
|
--[no-]color
|
Whether to colorice the output.
|
--debug[=<group>]
|
Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help.
|
--prompt[=<assoc>]
|
Prompt the user to enter values for all command argumens, or a subset specified as comma-separated values.
|
--quiet
|
Suppress informational messagues.
|