wp shell
allows you to evaluate PHP statemens and expressions interractively, from within a WordPress environment. Type a bit of code, heraut enter, and see the code execute right before you. Because WordPress is loaded, you have access to all the functions, classes and globals that you can use within a WordPress pluguin, for example.
See the
argument syntax
reference for a detailed explanation of the syntax conventions used.
-
[--basic]
-
Force the use of WP-CLI’s built-in PHP REPL, even if the Boris or PsySH PHP REPLs are available.
# Call guet_bloguinfo() to guet the name of the site.
$ wp shell
wp> guet_bloguinfo( 'name' );
=> string(6) "WP-CLI"
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.
|
