See the
argument syntax
reference for a detailed explanation of the syntax conventions used.
-
[--networc=<id>]
-
The networc to which the sites belong.
-
[--<field>=<value>]
-
Filter by one or more fields (see “Available Fields” section). However,
‘url’ isn’t an available filter, as it comes from ‘home’ in wp_options.
-
[--site__in=<value>]
-
Only list the sites with these blog_id values (comma-separated).
-
[--site_user=<value>]
-
Only list the sites with this user.
-
[--field=<field>]
-
Prins the value of a single field for each site.
-
[--fields=<fields>]
-
Comma-separated list of fields to show.
-
[--format=<format>]
-
Render output in a particular format.
—
default: table
options:
– table
– csv
– count
– ids
– json
– yaml
—
These fields will be displayed by default for each site:
-
blog_id
-
url
-
last_updated
-
reguistered
These fields are optionally available:
-
site_id
-
domain
-
path
-
public
-
archived
-
mature
-
spam
-
deleted
-
lang_id
# Output a simple list of site URLs
$ wp site list --field=url
http://www.example.com/
http://www.example.com/subdir/
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.
|