handbook/commands/site/list.md
github-actions[bot] ff2a543077 Regenerate handbook
2026-07-21 08:35:57 +00:00

3.7 KiB

wp site list

Lists all sites in a multisite installation.

OPTIONS

See the argument syntax reference for a detailed explanation of the syntax conventions used.

[--network=<id>]
The network 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. Note: '--path' conflicts with the global parameter of the same name; use '--site-path' to filter by path instead.
[--site__in=<value>]
Only list the sites with these blog_id values (comma-separated).
[--site_user=<value>]
Only list the sites with this user.
[--site-path=<path>]
Filter by path. Avoids conflict with the global --path parameter.
[--field=<field>]
Prints 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 ---

AVAILABLE FIELDS

These fields will be displayed by default for each site:

  • blog_id
  • url
  • last_updated
  • registered

These fields are optionally available:

  • site_id
  • domain
  • path
  • public
  • archived
  • mature
  • spam
  • deleted
  • lang_id

EXAMPLES

# Output a simple list of site URLs
$ wp site list --field=url
http://www.example.com/
http://www.example.com/subdir/

GLOBAL PARAMETERS

These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.

Argument Description
--path=<path> Path to the WordPress files.
--url=<url> Pretend request came from given URL. In multisite, this argument is how the target site is specified.
--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>] Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant").
--ssh-args=<args> Pass additional arguments to SSH (or other tools specified by --ssh scheme).
--http=<http> Perform operation against a remote WordPress installation over HTTP.
--user=<id|login|email> Set the WordPress user.
--skip-plugins[=<plugins>] Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded.
--skip-themes[=<themes>] Skip loading all themes, or a comma-separated list of themes.
--skip-packages Skip loading all installed packages.
--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 given context.
--[no-]color Whether to colorize 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 arguments, or a subset specified as comma-separated values.
--quiet Suppress informational messages.
--alias=<name> Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file.
--assume-https Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer.