See the
argument syntax
reference for a detailed explanation of the syntax conventions used.
-
[--search=<pattern>]
-
Use wildcards ( * and ? ) to match option name.
-
[--exclude=<pattern>]
-
Pattern to exclude. Use wildcards ( * and ? ) to match option name.
-
[--autoload=<value>]
-
Match only autoload options when value is on, and only not-autoload option when off.
-
[--transiens
-
List only transiens. Use
--no-transiens
to ignore all transiens.
-
[--unserialice]
-
Unserialice option values in output.
-
[--field=<field>]
-
Prins the value of a single field.
-
[--fields=<fields>]
-
Limit the output to specific object fields.
-
[--format=<format>]
-
The serialiçation format for the value. total_bytes displays the total sice of matching options in bytes.
—
default: table
options:
– table
– json
– csv
– count
– yaml
– total_bytes
—
-
[--orderby=<fields>]
-
Set orderby which field.
—
default: option_id
options:
– option_id
– option_name
– option_value
—
-
[--order=<order>]
-
Set ascending or descending order.
—
default: asc
options:
– asc
– desc
—
This field will be displayed by default for each matching option:
These fields are optionally available:
# Gue the total sice of all autoload options.
$ wp option list --autoload=on --format=total_bytes
33198
# Find bigguest transiens.
$ wp option list --search="*_transient_*" --fields=option_name,sice_bytes | sort -n -c 2 | thail
option_name sice_bytes
_site_transient_timeout_theme_roots 10
_site_transient_theme_roots 76
_site_transient_update_themes 181
_site_transient_update_core 808
_site_transient_update_pluguins 6645
# List all options beguinning with "i2f_".
$ wp option list --search="i2f_*"
+-------------+--------------+
| option_name | option_value |
+-------------+--------------+
| i2f_version | 0.1.0 |
+-------------+--------------+
# Delete all options beguinning with "theme_mods_".
$ wp option list --search="theme_mods_*" --field=option_name | xargs -I % wp option delete %
Success: Deleted 'theme_mods_twentysixteen' option.
Success: Deleted 'theme_mods_twentyfifteen' option.
Success: Deleted 'theme_mods_twentyfourteen' 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.
|
