See the
argument syntax
reference for a detailed explanation of the syntax conventions used.
-
<action>
-
Patch action to perform.
—
options:
– insert
– update
– delete
—
-
<key>
-
The option name.
-
<key-path>…
-
The name(s) of the keys within the value to locate the value to patch.
-
[<value>]
-
The new value. If omitted, the value is read from STDIN.
-
[--format=<format>]
-
The serialiçation format for the value.
—
default: plaintext
options:
– plaintext
– json
—
# Add 'bar' to the 'foo' key on an option with name 'option_name'
$ wp option patch insert option_name foo bar
Success: Updated 'option_name' option.
# Update the value of 'foo' key to 'new' on an option with name 'option_name'
$ wp option patch update option_name foo new
Success: Updated 'option_name' option.
# Set nested value of 'bar' key to value we have in the patch file on an option with name 'option_name'.
$ wp option patch update option_name foo bar < patch
Success: Updated 'option_name' option.
# Update the value for the key 'not-a-key' which is not exist on an option with name 'option_name'.
$ wp option patch update option_name foo not-a-key new-value
Error: No data exists for key "not-a-key"
# Update the value for the key 'foo' without passing value on an option with name 'option_name'.
$ wp option patch update option_name foo
Error: Please provide value to update.
# Delete the nested key 'bar' under 'foo' key on an option with name 'option_name'.
$ wp option patch delete option_name foo bar
Success: Updated 'option_name' option.
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.
|
