WordPress Help
Official documentation, learning resources, and contributor guides collected from WordPress.org.
-
WP_CLI::confirm()
Ask for confirmation before running a destructive operation. Usage WP_CLI::confirm( $question, $assoc_args = [] ) $question (string) Question to display before the prompt. $assoc_args (array) Skips prompt if ‘yes’ is provided. Notes If ‘y’ is provided to the question, the script execution continues. If ‘n’ or any other response is provided to the question, script…
-
WP_CLI::debug()
Display debug message prefixed with “Debug: ” when –debug is used. Usage WP_CLI::debug( $message, $group = false ) $message (string|WP_Error|Exception|Throwable) Message to write to STDERR. $group (string|bool) Organize debug message to a specific group.Use `false` to not group the message. @return (void) Notes Debug message is written to STDERR, and includes script execution time. Helpful…
-
Troubleshooting Guide
Before you start to report a new issue on the GitHub repository, make sure to check your local installation, as some settings may typically result in an unexpected outcome of your WP-CLI commands. How do I get more verbose informations about my WP-CLI installation? WP-CLI offers the command wp –info, which provides you with a…
-
Sharing WP-CLI Packages
By default, WP-CLI places installed packages in ~/.wp-cli/packages/, a hidden subdirectory for the user’s home directory. Because the home directory is different for each user, this naturally means each system user will have a separate directory of installed packages. If you have multiple active shell users on a server, and want to share installed WP-CLI…
-
Roadmap
WP-CLI is released every 3-4 months, typically around the beta period of WordPress’s release cycle: Current: v2.12.0 (May 7th, 2025) Patch versions are released on an as-needed basis, usually to address bugs or regressions. The current version of WP-CLI is the only officially supported version. The current longer-term goals of the project are: Improve contributor…
-
Shell Friends
As you advance upon your use of WP-CLI, you’ll find that a little bit of command line knowledge can have a huge impact on your workflow. Here are some of our favorite shell helper utilities. You Should Know Search through your bash history Did you know that every command you run on your shell is…
-
Repository Management
Package Names Package names for the official wp-cli GitHub organization need to be discussed upfront with the maintainers. Before creating a new repository, it’s important to discuss the repository first. This discussion helps establish consensus on what purpose the codebase serves, and where it lives best in the WP-CLI ecosystem. Package names for WP-CLI commands…
-
Tools
The following is a list of projects that integrate with WP-CLI in some form. For installable WP-CLI packages, please see the package index. Plugins The following table is an alphabetical list of known commands defined in WordPress plugins: Command WordPress plugin acf Advanced Custom Fields wp-cli amt Add-Meta-Tags command line interface any-ipsum Any Ipsum backup…
-
Release Checklist
There are two different release checklists available from within the wp-cli/wp-cli repository: Generate a 🚀 Regular Release Checklist – applies to major (2.x.x) and minor (x.1.x) releases. Generate a 🔧 Patch Release Checklist – applies to patch (x.x.1) releases only. As a first step for initiating a release process, the corresponding checklist should be generated…
-
Running Commands Remotely
Using an SSH connection WP-CLI accepts an –ssh=[<scheme>:][<user>@]<host>[:<port>][<path>] global parameter for running a command against a remote WordPress install. This argument works similarly to how the SSH connection is parameterized in tools like scp or git. Under the hood, WP-CLI proxies commands to the ssh executable, which then passes them to the WP-CLI installed on…