Global Options
Global options (parameters, arguments) can be applied to any command. These parameters behave the same for any command. They affect how WP-CLI interacts with WordPress in General.
List of global options
- --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”, “vagrant”).
- --http={http}
- Perform operation against a remote WordPress install 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).
- --[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.
- --context
allows users to select the WordPress context in which WP-CLI is supposed to execute its command(s).
-
cli
: The context which has been the default before introduction of this flag. This is something in-between a frontend and an admin request, to get around some of the quirks of WordPress when running on the console. -
admin
: A context that simulates running a command as if it would be executed in the administration backend. This is meant to be used to get around issues with plugins that limit functionality behind an is_admin() check. -
auto
: Switches betweencli
andadmin
depending on which command is being used. For this initial release, allwp plugin *
andwp theme *
commands will useadmin
, while all other commands will usecli
. frontend
: [WIP] This does nothing yet.
-
Where
[]
- you can specify or you can omit.{}
- the values in braces are the variable values of the parameter.|
- this symbol indicates that you can specify either one or the other value.
Examples
Let's get all the Metafields of post 18 for the network site woman.example.com:
wp post meta list 18 --url=woman.example.com
Run the command from any directory, you need to specify WP path in this case (where the file wp-settings.php is located):
wp post meta list 1 --path=/home/kama/sites/wp-kama.dev/public_html/core/
Execute the PHP file before running the command:
wp post meta list 1 --require=/path/to/file.php