WP-CLI

https://github.com/wp-cli/handbook
Admin
WP-CLI is a command-line interface for WordPress that allows you to manage your WordPress...
Tokens:466,391
Snippets:4,188
Trust Score:9.4
License:MIT
Update:12 hours ago
Show doc for...
Tokens:
Raw
### Install WP-CLI package examples

Source: https://github.com/wp-cli/handbook/blob/main/commands/package/install.md

Shows various ways to install a WP-CLI package using the wp package install command, including version constraints, Git URLs, and .zip files.

```bash
# Install the latest stable version of a package.
$ wp package install runcommand/hook
```

```bash
# Install a specific version.
$ wp package install wp-cli/server-command:2.0.0
```

```bash
# Install with caret operator (allows non-breaking updates).
$ wp package install wp-cli/server-command:^1.0
```

```bash
# Install with tilde operator (allows patch-level updates).
$ wp package install wp-cli/server-command:~1.2
```

```bash
# Install the latest stable version (explicitly specified).
$ wp package install wp-cli/server-command:@stable
```

```bash
# Install from a development branch.
$ wp package install wp-cli/server-command:dev-main
```

```bash
# Install a package hosted at a GitLab.com URL.
$ wp package install https://gitlab.com/foo/wp-cli-bar-command.git
```

```bash
# Install a package in a .zip file.
$ wp package install google-sitemap-generator-cli.zip
```

--------------------------------

### Example output of wp --info

Source: https://github.com/wp-cli/handbook/blob/main/guides/installing.md

Example output from running `wp --info` after a successful installation. Shows the expected format and fields.

```text
OS:  Linux 4.10.0-42-generic #46~16.04.1-Ubuntu SMP Mon Dec 4 15:57:59 UTC 2017 x86_64
Shell:   /usr/bin/zsh
PHP binary:    /usr/bin/php
PHP version:     7.1.12-1+ubuntu16.04.1+deb.sury.org+1
php.ini used:   /etc/php/7.1/cli/php.ini
MySQL binary:
MySQL version:
SQL modes:
WP-CLI root dir:        /home/wp-cli/.wp-cli
WP-CLI packages dir:    /home/wp-cli/.wp-cli/packages/
WP-CLI global config:   /home/wp-cli/.wp-cli/config.yml
WP-CLI project config:
WP-CLI version: 1.5.0
```

--------------------------------

### wp core commands: download, install, version

Source: https://github.com/wp-cli/handbook/blob/main/commands/core.md

These examples show common wp core commands: downloading WordPress with a locale, installing it with site details, and displaying the version. Each command includes its expected output.

```bash
# Download WordPress core
$ wp core download --locale=nl_NL
Downloading WordPress 4.5.2 (nl_NL)...
md5 hash verified: c5366d05b521831dd0b29dfc386e56a5
Success: WordPress downloaded.
```

```bash
# Install WordPress
$ wp core install --url=example.com --title=Example --admin_user=supervisor --admin_password=strongpassword --admin_email=info@example.com
Success: WordPress installed successfully.
```

```bash
# Display the WordPress version
$ wp core version
4.5.2
```

--------------------------------

### wp transient set, get, and delete examples

Source: https://github.com/wp-cli/handbook/blob/main/commands/transient.md

These examples show the basic wp transient commands: set, get, and delete, including the --expired, --all, and --network flags. The output lines show the expected success messages and returned values.

```bash
$ wp transient set sample_key "test data" 3600
Success: Transient added.
```

```bash
$ wp transient get sample_key
test data
```

```bash
$ wp transient delete sample_key
Success: Transient deleted.
```

```bash
$ wp transient delete --expired
Success: 12 expired transients deleted from the database.
```

```bash
$ wp transient delete --all
Success: 14 transients deleted from the database.
```

```bash
$ wp transient delete --all --network
Success: 2 transients deleted from the database.
```

--------------------------------

### Clone and install a specific WP-CLI command/package

Source: https://github.com/wp-cli/handbook/blob/main/contributions/pull-requests.md

Steps to set up a local development environment for a specific WP-CLI command/package, using the wp core command as an example. Install Composer, clone the repository, install dependencies, and verify with vendor/bin/wp --info.

```bash
git clone https://github.com/wp-cli/core-command.git
```

```bash
cd core-command
```

```bash
composer install
```

```bash
vendor/bin/wp --info
```

--------------------------------

### Annotated example wp-cli.yml file

Source: https://github.com/wp-cli/handbook/blob/main/references/config.md

Example configuration file showing global parameter defaults, subcommand defaults for 'wp config create', aliases to other WordPress installs, alias groups, and special '_' options for merging and inheriting configuration.

```yaml
# Global parameter defaults
path: wp-core
url: http://example.com
user: admin
color: false
disabled_commands:
  - db drop
  - plugin install
require:
  - path-to/command.php

# Subcommand defaults (e.g. `wp config create`)
config create:
	dbuser: root
	dbpass: 
	extra-php: |
		define( 'WP_DEBUG', true );
		define( 'WP_POST_REVISIONS', 50 );

# Aliases to other WordPress installs (e.g. `wp @staging rewrite flush`)
# An alias can include 'user', 'url', 'path', 'ssh', or 'http'
@staging:
	ssh: wpcli@staging.wp-cli.org
	user: wpcli
	path: /srv/www/staging.wp-cli.org
@production:
	ssh: wpcli@wp-cli.org:2222
	user: wpcli
	path: /srv/www/wp-cli.org

# Aliases can reference other aliases to create alias groups
# Alias groups can be nested
@both:
 - @staging
 - @production

# '_' is a special value denoting configuration options for this wp-cli.yml
_:
	# Merge subcommand defaults from the upstream config.yml, instead of overriding
	merge: true
	# Inherit configuration from an arbitrary YAML file
	inherit: prod.yml
```

--------------------------------

### WP-CLI package install command and output

Source: https://github.com/wp-cli/handbook/blob/main/contributions/bug-reports.md

Example output from installing a WP-CLI package, showing the command and its full output including the success message.

```bash
$ wp package install wp-cli/scaffold-package-command:@stable
Installing package wp-cli/scaffold-package-command (@stable)
Updating /root/.wp-cli/packages/composer.json to require the package...
Using Composer to install the package...
---
Loading composer repositories with package information
Updating dependencies
Resolving dependencies through SAT
Dependency resolution completed in 0.001 seconds
Analyzed 421 packages to resolve dependencies
Analyzed 96 rules to resolve dependencies
Package operations: 1 install, 0 updates, 0 removals
Installs: wp-cli/scaffold-package-command:1.2.0
 - Installing wp-cli/scaffold-package-command (1.2.0)
Writing lock file
Generating autoload files
---
Success: Package installed.
```

--------------------------------

### wp core multisite-install example with output

Source: https://github.com/wp-cli/handbook/blob/main/commands/core/multisite-install.md

Runs the multisite installation with a title, admin user, password, and email. The output confirms the database tables are set up and constants added, with a success message reminding to set up rewrite rules.

```bash
$ wp core multisite-install --title="Welcome to the WordPress" \
> --admin_user="admin" --admin_password="password" \
> --admin_email="user@example.com"
Single site database tables already present.
Set up multisite database tables.
Added multisite constants to wp-config.php.
Success: Network installed. Don't forget to set up rewrite rules.
```

--------------------------------

### Start web server with default settings

Source: https://github.com/wp-cli/handbook/blob/main/how-to/how-to-start-webserver.md

Runs `wp server` to start PHP's built-in web server on localhost:8080. The output shows the server startup message and the URL to access the WordPress installation.

```bash
$ wp server
PHP 7.2.24-0ubuntu0.18.04.4 Development Server started at Thu Jun  4 17:40:13 2020
Listening on http://localhost:8080
Document root is ../wpdemo.test
Press Ctrl-C to quit.
```

--------------------------------

### Install a font face with porcelain output

Source: https://github.com/wp-cli/handbook/blob/main/commands/font/face/install.md

Installs a font face using the `--porcelain` flag to output only the new font face ID. The example uses a local file path for the source.

```bash
$ wp font face install 42 --src="font.woff2" --porcelain
44
```

--------------------------------

### Launch WP-CLI command in background

Source: https://github.com/wp-cli/handbook/blob/main/references/behat-steps/when-i-launch-in-the-background.md

Use this Behat step to start a WP-CLI command as a background process, such as `wp server`, so it does not block the scenario. The example shows a typical scenario setup with a WP install before launching the server.

```gherkin
Scenario: My example scenario
  Given a WP install
  And I launch in the background `wp server --host=localhost --port=8181`
  ...
```

--------------------------------

### Example: Run plugin list with options

Source: https://github.com/wp-cli/handbook/blob/main/references/internal-api/wp-cli-runcommand.md

Configures options to return STDOUT, parse JSON, reuse the current process, halt on error, and pass '--skip-themes'. Then runs 'plugin list --format=json'.

```php
$options = array(
  'return'       => true,                // Return 'STDOUT'; use 'all' for full object.
  'parse'        => 'json',              // Parse captured STDOUT to JSON array.
  'launch'       => false,               // Reuse the current process.
  'exit_error'   => true,                // Halt script execution on error.
  'command_args' => [ '--skip-themes' ], // Additional arguments to be passed to the $command.
);
$plugins = WP_CLI::runcommand( 'plugin list --format=json', $options );
```

--------------------------------

### Get path to an installed package

Source: https://github.com/wp-cli/handbook/blob/main/commands/package/path.md

Shows the command to get the path to a specific installed package, using the package name 'wp-cli/server-command'. The output is the full path to that package.

```bash
$ wp package path wp-cli/server-command
/home/person/.wp-cli/packages/vendor/wp-cli/server-command
```

--------------------------------

### Command annotation example for wp cron event schedule

Source: https://github.com/wp-cli/handbook/blob/main/references/documentation-standards.md

PHPdoc annotation for the `wp cron event schedule` command. The description must be under 50 characters and written in active, present tense. Options section starts with `## OPTIONS` and examples with `## EXAMPLES`, each with blank lines before and after headings. Each example has three parts: description (starting with `#` and a space, capital letter, ending with punctuation), command (starting with `$` and a space), and sample output (exact output, may be truncated if long).

```php
/**
 * Schedule a new cron event.
 *
 * ## OPTIONS
 *
 * <hook>
 * : The hook name.
 *
 * [<next-run>]
 * : A Unix timestamp or an English textual datetime description compatible with `strtotime()`. Defaults to now.
 *
 * [<recurrence>]
 * : How often the event should recur. See `wp cron schedule list` for available schedule names. Defaults to no recurrence.
 *
 * [--<field>=<value>]
 * : Associative args for the event.
 *
 * ## EXAMPLES
 *
 *     # Schedule a new cron event.
 *     $ wp cron event schedule cron_test
 *     Success: Scheduled event with hook 'cron_test' for 2016-05-31 10:19:16 GMT.
 *
 *     # Schedule new cron event with hourly recurrence.
 *     $ wp cron event schedule cron_test now hourly
 *     Success: Scheduled event with hook 'cron_test' for 2016-05-31 10:20:32 GMT.
 *
 *     # Schedule new cron event and pass associative arguments.
 *     $ wp cron event schedule cron_test '+1 hour' --foo=1 --bar=2
 *     Success: Scheduled event with hook 'cron_test' for 2016-05-31 11:21:35 GMT.
 */
```

--------------------------------

### Install WordPress in 5 seconds

Source: https://github.com/wp-cli/handbook/blob/main/commands/core/install.md

Runs the standard WordPress installation with all required options. Outputs 'Success: WordPress installed successfully.' on success.

```bash
# Install WordPress in 5 seconds
$ wp core install --url=example.com --title=Example --admin_user=supervisor --admin_password=strongpassword --admin_email=info@example.com
Success: WordPress installed successfully.
```

--------------------------------

### Install and activate a plugin in one step

Source: https://github.com/wp-cli/handbook/blob/main/guides/common-tasks.md

Installs the plugin and activates it immediately using the --activate flag.

```bash
wp plugin install contact-form-7 --activate
```

--------------------------------

### Install a language with wp language core install

Source: https://github.com/wp-cli/handbook/blob/main/commands/language/core/install.md

Installs the specified language pack. The example installs Brazilian Portuguese (pt_BR) and shows the expected output, including the download URL and success message.

```bash
# Install the Brazilian Portuguese language.
$ wp language core install pt_BR
Downloading translation from https://downloads.wordpress.org/translation/core/6.5/pt_BR.zip...
Unpacking the update...
Installing the latest version...
Removing the old version of the translation...
Translation updated successfully.
Language 'pt_BR' installed.
Success: Installed 1 of 1 languages.
```

--------------------------------

### Behat scenario: expect HTTP status code 200

Source: https://github.com/wp-cli/handbook/blob/main/references/behat-steps/then-the-http-status-code-should-be-code.md

Use this step in a Behat scenario to verify that the WordPress site served at http://localhost:8080 returns the expected HTTP status code. The example expects a 200 response after setting up a WP installation with Composer and starting a PHP built-in web server.

```gherkin
Scenario: My example scenario
  Given a WP installation with Composer
  And a PHP built-in web server to serve 'WordPress'
  Then the HTTP status code should be 200
```

--------------------------------

### Get site meta with wp site meta get

Source: https://github.com/wp-cli/handbook/blob/main/commands/site/meta.md

Retrieves the value of a custom field for a site. The example gets the 'bio' field for site ID 123 and outputs the stored value.

```bash
# Get site meta
$ wp site meta get 123 bio
Mary is a WordPress developer.
```

--------------------------------

### Download and install WordPress with WP-CLI

Source: https://github.com/wp-cli/handbook/blob/main/guides/quick-start.md

Sequential steps to download and install WordPress using WP-CLI: download core, create wp-config.php, create the database, and install WordPress. Each command shows its expected output.

```bash
$ wp core download --path=wpclidemo.dev
Creating directory '/srv/www/wpclidemo.dev/'.
Downloading WordPress 4.6.1 (en_US)...
Using cached file '/home/vagrant/.wp-cli/cache/core/wordpress-4.6.1-en_US.tar.gz'...
Success: WordPress downloaded.
```

```bash
$ cd wpclidemo.dev
$ wp config create --dbname=wpclidemo --dbuser=root --prompt=dbpass
1/10 [--dbpass=<dbpass>]:
Success: Generated 'wp-config.php' file.
```

```bash
$ wp db create
Success: Database created.
```

```bash
$ wp core install --url=wpclidemo.dev --title="WP-CLI" --admin_user=wpcli --admin_password=wpcli --admin_email=info@wp-cli.org
Success: WordPress installed successfully.
```

--------------------------------

### Install and configure WordPress with WP-CLI function

Source: https://github.com/wp-cli/handbook/blob/main/references/shell-friends.md

Defines a shell function that downloads WordPress, creates a configuration with the given database name (using root credentials), creates the database, and runs the interactive install. Add this function to ~/.bashrc and reload the shell, then call wp_install with the directory name. Substitute the database credentials with your own.

```bash
wp_install () 
{ 
    wp core download --path=$1;
    cd $1;
    read -p 'name the database:' dbname;
    wp config create --dbname=$dbname --dbuser=root --dbpass=awoods --dbhost=localhost;
    wp db create;
    wp core install --prompt
}

$ source ~/.bashrc
$ wp_install new-site
```

--------------------------------

### Get a comment field

Source: https://github.com/wp-cli/handbook/blob/main/commands/comment/get.md

Retrieves the value of a single field for a comment. The example gets the 'content' field of comment 21 and outputs the comment content.

```bash
# Get comment.
$ wp comment get 21 --field=content
Thanks for all the comments, everyone!
```

--------------------------------

### Set up wp-cli-dev development environment

Source: https://github.com/wp-cli/handbook/blob/main/contributions/hack-day.md

Clones the wp-cli-dev repository and runs the installation process. Requires Composer, PHP, and a MySQL or MariaDB server. After installation, all WP-CLI repositories are available locally for changes.

```bash
git clone https://github.com/wp-cli/wp-cli-dev wp-cli-dev
cd wp-cli-dev
composer install
composer prepare-tests
```

--------------------------------

### Download, verify, and install WP-CLI

Source: https://github.com/wp-cli/handbook/blob/main/guides/verifying-downloads.md

Complete workflow to download, verify, and install WP-CLI. It downloads the phar and its GPG signature, imports the signing key (first time only), verifies the signature, tests the phar, moves it to /usr/local/bin/wp, and confirms the installation with wp --info.

```bash
# Download WP-CLI
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

# Download signature
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar.asc

# Import signing key (first time only)
curl -L https://raw.githubusercontent.com/wp-cli/builds/gh-pages/wp-cli.pgp | gpg --import

# Verify signature
gpg --verify wp-cli.phar.asc wp-cli.phar

# If verification succeeds, test it works
php wp-cli.phar --info

# Make executable and move to PATH
chmod +x wp-cli.phar
sudo mv wp-cli.phar /usr/local/bin/wp

# Verify installation
wp --info
```

--------------------------------

### Check if German language is installed

Source: https://github.com/wp-cli/handbook/blob/main/commands/language/core/is-installed.md

Runs the command to check if the German language (de_DE) is installed. The exit status is 0 if installed, otherwise 1. The example shows the command and then echoes the exit status, which is 1 in this case.

```bash
# Check whether the German language is installed; exit status 0 if installed, otherwise 1.
$ wp language core is-installed de_DE
$ echo $?
1
```

--------------------------------

### Clone and install the entire WP-CLI project

Source: https://github.com/wp-cli/handbook/blob/main/contributions/pull-requests.md

Steps to set up a local development environment for the entire WP-CLI project. Clone the main repository, install dependencies with --prefer-source, alias the wp command, and verify with wp --info.

```bash
git clone git@github.com:wp-cli/wp-cli.git ~/wp-cli
```

```bash
cd ~/wp-cli
```

```bash
git remote add fork git@github.com:yourusername/wp-cli.git
```

```bash
composer install --prefer-source
```

```bash
alias wp='~/wp-cli/bin/wp'
```

```bash
wp --info
```

--------------------------------

### Check if a theme is installed with wp theme is-installed

Source: https://github.com/wp-cli/handbook/blob/main/commands/theme/is-installed.md

Runs the command to check if the theme 'hello' is installed. The exit status is 0 if installed, otherwise 1. The example shows the command and then echoes the exit status, which outputs 1.

```bash
# Check whether theme is installed; exit status 0 if installed, otherwise 1
$ wp theme is-installed hello
$ echo $?
1
```

--------------------------------

### Check if German language is installed for Twenty Seventeen

Source: https://github.com/wp-cli/handbook/blob/main/commands/language/theme/is-installed.md

Runs the command to check if the German language (de_DE) is installed for the Twenty Seventeen theme. The exit status is 0 if installed, 1 if not. The example shows the command and the resulting exit status.

```bash
# Check whether the German language is installed for Twenty Seventeen; exit status 0 if installed, otherwise 1.
$ wp language theme is-installed twentyseventeen de_DE
$ echo $?
1
```

--------------------------------

### Install a plugin with all its dependencies

Source: https://github.com/wp-cli/handbook/blob/main/commands/plugin/install.md

Installs a plugin along with all its dependencies using the `--with-dependencies` flag. The output shows the installation of each dependency and the main plugin.

```bash
# Install a plugin with all its dependencies
$ wp plugin install my-plugin --with-dependencies
Installing Required Plugin 1 (1.2.3)
Plugin installed successfully.
Installing Required Plugin 2 (2.0.0)
Plugin installed successfully.
Installing My Plugin (3.5.0)
Plugin installed successfully.
Success: Installed 3 of 3 plugins.
```

--------------------------------

### Initialize the testing environment locally

Source: https://github.com/wp-cli/handbook/blob/main/how-to/plugin-unit-tests.md

Runs the install script to set up WordPress and the test database. Parameters: `wordpress_test` (database name, all data deleted), `root` (MySQL user), `''` (password), `localhost` (host), `latest` (WordPress version). Can be run multiple times but will not overwrite existing files.

```bash
bash bin/install-wp-tests.sh wordpress_test root '' localhost latest
```

--------------------------------

### wp plugin list

Source: https://github.com/wp-cli/handbook/blob/main/commands/plugin/list.md

Gets a list of plugins installed on the site. Displays activation status, update availability, and other details. Use --status=dropin to list installed dropins.

```APIDOC
## wp plugin list

### Description
Gets a list of plugins installed on the site. Displays activation status, whether there's an update available, etc. Use `--status=dropin` to list installed dropins (e.g. `object-cache.php`).

### Method
CLI

### Command
`wp plugin list`

### Parameters
#### Options
- `--<field>=<value>` (string) - Optional - Filter results based on the value of a field.
- `--field=<field>` (string) - Optional - Prints the value of a single field for each plugin.
- `--fields=<fields>` (string) - Optional - Limit the output to specific object fields.
- `--format=<format>` (string) - Optional - Render output in a particular format. Default: table. Options: table, csv, count, json, yaml.
- `--status=<status>...` (string) - Optional - Filter the output by plugin status. Options: active, active-network, dropin, inactive, must-use.
- `--skip-update-check` (flag) - Optional - If set, the plugin update check will be skipped.
- `--recently-active` (flag) - Optional - If set, only recently active plugins will be shown and the status filter will be ignored.

### Available Fields
These fields are displayed by default for each plugin:
- name
- status
- update
- version
- update_version
- auto_update

These fields are optionally available:
- update_package
- update_id
- title
- description
- file
- author
- tested_up_to
- requires
- requires_php
- wporg_status
- wporg_last_updated
- auto_update_indicated

### Examples

#### List active plugins on the site.
```
$ wp plugin list --status=active --format=json
[{"name":"dynamic-hostname","status":"active","update":"none","version":"0.4.2","update_version":"","auto_update":"off"},{"name":"tinymce-templates","status":"active","update":"none","version":"4.8.1","update_version":"","auto_update":"off"},{"name":"wp-multibyte-patch","status":"active","update":"none","version":"2.9","update_version":"","auto_update":"off"},{"name":"wp-total-hacks","status":"active","update":"none","version":"4.7.2","update_version":"","auto_update":"off"}]
```

#### List plugins on each site in a network.
```
$ wp site list --field=url | xargs -I % wp plugin list --url=%
+---------+----------------+-----------+---------+-----------------+------------+
| name    | status         | update    | version | update_version | auto_update |
+---------+----------------+-----------+---------+----------------+-------------+
| akismet | active-network | none      | 5.3.1   |                | on          |
| hello   | inactive       | available | 1.6     | 1.7.2          | off         |
+---------+----------------+-----------+---------+----------------+-------------+
+---------+----------------+-----------+---------+----------------+-------------+
| name    | status         | update    | version | update_version | auto_update |
+---------+----------------+-----------+---------+----------------+-------------+
| akismet | active-network | none      | 5.3.1   |                | on          |
| hello   | inactive       | available | 1.6     | 1.7.2          | off         |
+---------+----------------+-----------+---------+----------------+-------------+
```

#### Check whether plugins are still active on WordPress.org
```
$ wp plugin list --fields=name,wporg_status,wporg_last_updated
+--------------------+--------------+--------------------+
| name               | wporg_status | wporg_last_updated |
+--------------------+--------------+--------------------+
| akismet            | active       | 2023-12-11         |
| user-switching     | active       | 2023-11-17         |
| wordpress-importer | active       | 2023-04-28         |
| local              |              |                    |
+--------------------+--------------+--------------------+
```

#### List recently active plugins on the site.
```
$ wp plugin list --recently-active --field=name --format=json
["akismet","bbpress","buddypress"]
```
```

--------------------------------

### Start server on any address with port 8080

Source: https://github.com/wp-cli/handbook/blob/main/commands/server.md

Binds the server to 0.0.0.0 on port 8080. Output shows the server starting and listening on http://0.0.0.0:8080.

```bash
$ wp server --host=0.0.0.0
PHP 5.6.9 Development Server started at Tue May 24 01:27:11 2016
Listening on http://0.0.0.0:8080
Document root is /
Press Ctrl-C to quit.
```

--------------------------------

### WP-CLI bootstrap code

Source: https://github.com/wp-cli/handbook/blob/main/contributions/implementation-details.md

The initial setup code executed when the 'wp' command starts, defining WP_CLI constants, setting common headers, and including core files before starting the runner.

```php
<?php

// Can be used by plugins/themes to check if WP-CLI is running or not
define( 'WP_CLI', true );
define( 'WP_CLI_VERSION', trim( file_get_contents( WP_CLI_ROOT . '/VERSION' ) ) );
define( 'WP_CLI_START_MICROTIME', microtime( true ) );

// Set common headers, to prevent warnings from plugins
$_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
$_SERVER['HTTP_USER_AGENT'] = '';
$_SERVER['REQUEST_METHOD'] = 'GET';
$_SERVER['REMOTE_ADDR'] = '127.0.0.1';

include WP_CLI_ROOT . '/php/utils.php';
include WP_CLI_ROOT . '/php/dispatcher.php';
include WP_CLI_ROOT . '/php/class-wp-cli.php';
include WP_CLI_ROOT . '/php/class-wp-cli-command.php';

\WP_CLI\Utils\load_dependencies();

WP_CLI::get_runner()->start();

```

--------------------------------

### wp plugin install synopsis

Source: https://github.com/wp-cli/handbook/blob/main/guides/commands-cookbook.md

Shows the usage synopsis for the `wp plugin install` command, illustrating positional and associative arguments. Square brackets denote optional arguments.

```bash
$ wp plugin install
usage: wp plugin install <plugin|zip|url>... [--version=<version>] [--force] [--activate] [--activate-network]
```

--------------------------------

### Example: Verify WordPress archive hash with http_request()

Source: https://github.com/wp-cli/handbook/blob/main/references/internal-api/wp-cli-utils-http-request.md

Example from the notes section showing how to make a GET request to fetch an MD5 hash and check the status code. Note the example uses $response->status_code in the error message, which may be a typo for $md5_response.

```php
# `wp core download` verifies the hash for a downloaded WordPress archive

$md5_response = Utils\http_request( 'GET', $download_url . '.md5' );
if ( 20 != substr( $md5_response->status_code, 0, 2 ) ) {
     WP_CLI::error( "Couldn't access md5 hash for release (HTTP code {$response->status_code})" );
}
```

--------------------------------

### Install from a local zip file

Source: https://github.com/wp-cli/handbook/blob/main/commands/plugin/install.md

Installs a plugin from a local zip file. The output shows the installation process and success message.

```bash
# Install from a local zip file
$ wp plugin install ../my-plugin.zip
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Success: Installed 1 of 1 plugins.
```

--------------------------------

### Get system information useful for troubleshooting

Source: https://github.com/wp-cli/handbook/blob/main/guides/common-tasks.md

Displays system information about the WordPress installation and environment.

```bash
wp --info
```

--------------------------------

### Install and get the family ID with --porcelain

Source: https://github.com/wp-cli/handbook/blob/main/commands/font/family/install.md

Installs the 'Roboto' font family from the 'google-fonts' collection and outputs only the new font family ID (43) when using the `--porcelain` flag.

```bash
$ wp font family install google-fonts roboto --porcelain
43
```

--------------------------------

### Execute an ability with simple string arguments

Source: https://github.com/wp-cli/handbook/blob/main/commands/ability/run.md

Runs the `my-plugin/greet` ability with a simple string field `--name=World`. No output is shown in the example.

```bash
$ wp ability run my-plugin/greet --name=World
```

--------------------------------

### Create user with role and show password

Source: https://github.com/wp-cli/handbook/blob/main/commands/user/create.md

Creates a user with the login 'bob', email 'bob@example.com', and role 'author'. The command outputs a success message and the generated password.

```bash
# Create user
$ wp user create bob bob@example.com --role=author
Success: Created user 3.
Password: k9**&I4vNH(&
```

--------------------------------

### Get theme details with wp theme get

Source: https://github.com/wp-cli/handbook/blob/main/commands/theme.md

Retrieves details of an installed theme using the --fields flag to specify which fields to display. The output is a table with the requested fields and their values.

```bash
# Get details of an installed theme
$ wp theme get twentysixteen --fields=name,title,version
+---------+----------------+
| Field   | Value          |
+---------+----------------+
| name    | Twenty Sixteen |
| title   | Twenty Sixteen |
| version | 1.2            |
+---------+----------------+
```

--------------------------------

### Check plugin installation status with exit code

Source: https://github.com/wp-cli/handbook/blob/main/commands/plugin/is-installed.md

Run `wp plugin is-installed hello` to check if the 'hello' plugin is installed. The command outputs nothing; the exit status is 0 if installed, 1 if not. The example shows the command followed by `echo $?` to display the exit code.

```bash
# Check whether plugin is installed; exit status 0 if installed, otherwise 1
$ wp plugin is-installed hello
$ echo $?
1
```

--------------------------------

### Given download: usage example

Source: https://github.com/wp-cli/handbook/blob/main/references/behat-steps/given-download.md

Downloads multiple files into the given destinations. The step uses a table with 'path' and 'url' columns, where placeholders like {CACHE_DIR} can be used in the path.

```gherkin
Scenario: My example scenario
  Given download:
    | path                | url                                   |
    | {CACHE_DIR}/foo.jpg | https://example.com/foo.jpg           |
    | {CACHE_DIR}/bar.png | https://example.com/another-image.png |
```

--------------------------------

### Check if a package is installed with wp package is-installed

Source: https://github.com/wp-cli/handbook/blob/main/commands/package/is-installed.md

Run `wp package is-installed foo/bar` to check if the package 'foo/bar' is installed. The command returns exit code 0 when installed, 1 when uninstalled. The example shows the command followed by `echo $?` to display the exit status.

```bash
# Check whether "foo/bar" is installed; exit status 0 if installed, otherwise 1
$ wp package is-installed foo/bar
$ echo $?
1
```

--------------------------------

### Install WordPress with wp core install

Source: https://github.com/wp-cli/handbook/blob/main/how-to/how-to-install.md

Runs the final installation command with site URL, title, admin user, password, and email. Replace the option values with your own details.

```bash
$ wp core install --url=wpclidemo.dev --title="WP-CLI" --admin_user=wpcli --admin_password=wpcli --admin_email=info@wp-cli.org
Success: WordPress installed successfully.
```

--------------------------------

### Prepare MySQL test database

Source: https://github.com/wp-cli/handbook/blob/main/guides/behat-tests.md

Runs the setup script to create the MySQL test database. This creates a user `wp_cli_test` with password `password1` and full privileges on the `wp_cli_test` database.

```bash
composer prepare-tests

```

--------------------------------

### Display WP-CLI version

Source: https://github.com/wp-cli/handbook/blob/main/commands/cli.md

Shows the currently installed WP-CLI version. Output example: WP-CLI 0.24.1.

```bash
$ wp cli version
WP-CLI 0.24.1
```

--------------------------------

### List all abilities with default table output

Source: https://github.com/wp-cli/handbook/blob/main/commands/ability/list.md

Displays all registered abilities in a table with columns for name, label, category, and description. The output shows example rows for core/get-site-info and core/get-user-info.

```bash
$ wp ability list
+---------------------------+----------------------+----------+------------------------------------------+
| name                      | label                | category | description                              |
+---------------------------+----------------------+----------+------------------------------------------+
| core/get-site-info        | Get Site Information | site     | Returns site information configured i... |
| core/get-user-info        | Get User Information | user     | Returns basic profile details for the... |
+---------------------------+----------------------+----------+------------------------------------------+
```

--------------------------------

### Get post ID by URL with wp post url-to-id

Source: https://github.com/wp-cli/handbook/blob/main/commands/post/url-to-id.md

Run the command with a URL to get the post ID. The example shows the command and its output, where the URL `https://example.com/?p=1` returns the ID `1`.

```bash
# Get post ID by URL
$ wp post url-to-id https://example.com/?p=1
1
```

--------------------------------

### wp scaffold command examples

Source: https://github.com/wp-cli/handbook/blob/main/commands/scaffold.md

These examples show how to use the wp scaffold command to generate a plugin, a theme based on _s, and a post type registration file. Each command includes its expected success output.

```bash
$ wp scaffold plugin sample-plugin
Success: Created plugin files.
Success: Created test files.
```

```bash
$ wp scaffold _s sample-theme --theme_name="Sample Theme" --author="John Doe"
Success: Created theme 'Sample Theme'.
```

```bash
$ wp scaffold post-type movie --label=Movie --theme=simple-life
Success: Created '/var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php'.
```

--------------------------------

### Get cache value with wp cache get

Source: https://github.com/wp-cli/handbook/blob/main/commands/cache/get.md

Retrieves a value from the object cache. The command requires a cache key and optionally a group. If the value does not exist, an error is returned. The example shows the command and its output.

```bash
# Get cache.
$ wp cache get my_key my_group
my_value
```

--------------------------------

### wp post create, update, and delete examples

Source: https://github.com/wp-cli/handbook/blob/main/commands/post.md

Shows the basic wp post commands for creating, updating, and deleting posts. Each command includes its expected success output.

```bash
# Create a new post.
$ wp post create --post_type=post --post_title='A sample post'
Success: Created post 123.
```

```bash
# Update an existing post.
$ wp post update 123 --post_status=draft
Success: Updated post 123.
```

```bash
# Delete an existing post.
$ wp post delete 123
Success: Trashed post 123.
```
Tokens:
Raw