Upcoming release v2.2.0

There’s a new release in the making: WP-CLI v2.2.0 is scheduled for Wednesday, April 24th, 2019.

We already have a lot of nice improvements in the pipeline, but there’s still time to have your code included if you want to be a part of that release:

I will prioritize the bugs and some of the more important issues into a checklist for the upcoming release that will be available for WordCamp London, so I hope to see many, many people join us for the Contributor Day on April 5th.

Random note: The scheduled date for the v2.2.0 release coincides with the Contributor Day for WordCamp Paris. Maybe we can arrange for something special on that day?

WP-CLI PHP Requirements Strategy

Up until now, WordPress Core was keeping a very low PHP minimum requirement, to support as many legacy server platforms as possible. As a result, WP-CLI tried to stay as low as possible with its own PHP minimum requirement, within reason. It made sense to not randomly break support for people stuck on lower PHP versions if we could easily avoid it.

WordPress Core is now planning to switch to a different approach for dealing with minimum PHP requirements, as recently announced on the Make/core blog: “Updating the Minimum PHP Version”.

As soon as WordPress Core has moved past WP-CLI in terms of minimum PHP version, we will try to adapt WP-CLI, but with a 1-year delay at the least. This delay is meant to allow site owners to still use WP-CLI to migrate their old sites over to newer servers. One year of additional support should be ample time to work on migrating your server over from an unsupported PHP platform.

After this year, we might raise the minimum as well, or wait for a more strategic moment to do so.

So this will be the guarantee that WP-CLI provides moving forward: Whenever WordPress Core raises the PHP minimum version requirement past WP-CLI, WP-CLI will stay at the old minimum requirement for at least 1 full year.

Given the current plans put forth in the above announcement, and considering the fact that there’s no real benefit to be had for WP-CLI to bump the requirement twice, the preliminary plan is to schedule WP-CLI v3 with PHP 7+ as a minimum requirement for December 2020.

The final announcement for a WP-CLI v3 release date will be done at a later date, probably closer to the end of this year.


WP-CLI v2.1.0 Release Notes

‘Tis the season to celebrate a new release of WP-CLI! 🎄 A total of 39 contributors has collaborated on this release to have a staggering 293 pull requests merged. We’ll go over the main areas now, but you also skip directly to the detailed changelog or ponder over the breaking changes section if you’re impatient.

i18n – round two!

The recent i18n make-pot command has replace the old make-pot tool in WordPress Core and is now the official translation build tool for the Core. This effort has lead to numerous improvements to make it both more robust and more flexible. Amongst the more notable changes, it can now parse JavaScript in addition to the PHP files, and together with the new i18n make-json command that lets you produce separate JSON files, you’re all set to make your Gutenberg blocks translatable!

Translation pack improvements

We didn’t stop there with regards to making WordPress an “international success”… the language family of commands got several improvements and fixes. The most notable one is that language plugin|theme update now understands an --all flag, so you can update language packs for all your installed plugins/themes in one go.
# Update the language packs for all plugins.
$ wp language plugin update --all
Updating 'Japanese' translation for Akismet 3.1.11...
Downloading translation from https://downloads.wordpress.org/translation/plugin/akismet/3.1.11/ja.zip...
Translation updated successfully.
Updating 'Japanese' translation for Contact Forms 7 4.2.1...
Translation updated successfully.
Success: Updated 2/2 translation.

Partial prompting

The lesser known --prompt global parameter has now become even more useful. Instead of always prompting for all arguments, it skips those that were already provided, as you would probably already have expected. One way this can be used is to prefill all arguments that you can remember and then use --prompt to help you with the more arcane flags. More importantly, though, you can now prefill all the arguments that are already known inside of a script, and then add the --prompt argument to let the script query the remaining information from the user.

Manage the WP-CLI cache

We added two additional commands that let you manage the WP-CLI internal cache. cli cache clear will clear the entire cache, whereas cli cache prune will only clear the elements known to be stale. This latter will for example remove all the versions of WP core that you downloaded except for the most recent one.
# Remove all cached files.
$ wp cli cache clear
Success: Cache cleared.

# Remove all cached files except for the newest version of each one.
$ wp cli cache prune
Success: Cache pruned.

Better control over transients

You can now list the current transients on your site or network using the filterable transient list command. You can search for specific transients or exclude the ones you want to hide. You can even choose whether you want the expiration to be displayed in a human-readable or machine-parseable format.
# List all transients
$ wp transient list
| name | value | expiration    |
| foo  | bar   | 39 mins       |
| foo2 | bar2  | no expiration |
| foo3 | bar2  | expired       |
| foo4 | bar4  | 4 hours       |
Furthermore, transients are now handled more consistently across multisite networks, and allow you to properly distinguish between regular transients and site transients.

Database management improvements

Also, the db size loved the idea of a --human-readable flag like in the transient list command so much that it got its own version. This will always use the unit that is best adapted to convey the information.
# List the size of the database in a human-readable form
$ wp db size --tables --human-readable
| Name    | Size   |
| my_site | 117 MB |
Furthermore, the db import command now understands all the flags that the mysql binary does, so that you can get past errors in SQL exports or adapt the result you want to see in your target site.
# Import an SQL export file that contains errors, by
# passing the --force argument to mysql binary.
$ wp db import export-with-errors.sql --force
Success: Imported from 'export-with-errors.sql'.

Smarter configuration

The config commands are now smarter. They not only allow you to edit the wp-config.php even on a broken WordPress installation, but you’re also able to retrieve the individual settings in whatever format best fits your scripting needs. Finally, adding new configuration values or updating existing ones will now only throw errors in the most ambiguous scenarios, while they just work for the majority use cases without the need to explicitly specify a --type.

Checking the existence of a post

You can now check whether a given post exists by using the new post exists command. It returns a shell exit code, so you can use it directly in shell conditionals.
if wp post exists 42; then
   echo "Skipping post import for ID 42, it already exists."
   echo "Importing post with ID 42..."
   # ...

Breaking changes

  • While we had already bumped the minimum PHP version in v2.0.0 and started using PHP 5.4+ code in some places, we now actively enforce this requirement in the bootstrapping code [wp-cli#5039](https://github.com/wp-cli/wp-cli/pull/5039).
  • The restructuring of the packages in v2.0.0 produced a regression which caused overrides through the package manager to not work anymore. We fixed this by completely ripping the framework out of the regular Composer autoload flow. This should now lead to less surprises when rearranging the Composer compositions, but might have side-effects in some exotic Composer setups [wp-cli#5010](https://github.com/wp-cli/wp-cli/pull/5010).
  • The breaking change from v2.0.1 to throw an error for non-lowercase theme slugs was reverted, as it broke far more than we anticipated. That’s why we now break the breaking change to get back to the original behavior [extension-command#137](https://github.com/wp-cli/extension-command/pull/137). 😛
  • WP-CLI tries to speak proper English now. To achieve this, we changed the output to use the real world “installation” where we were using the fantasy term “install” before [wp-cli#4946](https://github.com/wp-cli/wp-cli/pull/4946).

Complete change log


  • Bump PHP version to 5.4+ for PHP Compatibility Checker [#63]
  • Bump included package-command to v2.0.3 [#35]
  • Remove .behat-progress.log [#25]
  • Use dev-master for framework instead of tagged release [#24]
  • Add replace-label maintenance command [#17]


  • Properly reorder synopsis passed in via $args [#5049]
  • Bump PHP version check in bootstrap code to v5.4+ [#5039]
  • Remove ext-posix requirement from Composer file [#5038]
  • Fix override test on Composer stack [#5036]
  • PHP 7.0+: allow for changed list assignment order [#5021]
  • Skip associative arguments that were already provided on --prompt [#5015]
  • Bump PHP version to 5.4+ for PHP Compatibility Checker [#5014]
  • Use custom autoloader to load framework [#5010]
  • Add extension requirements to composer.json file [#5001]
  • Add ext-zip as suggested extension [#4998]
  • Fix parsing of arguments for WP_CLI::runcommand() with launch=false [#4989]
  • Match the way WordPress Core locates wp-config.php [#4984]
  • Use dirname() instead of .. to locate wp-config.php to match Core behavior [#4963]
  • Update README to account for the 280-character limit on Twitter [#4962]
  • Use “installation” instead of “install” in documentation [#4960]
  • Bump included package-command to v2.0.3 [#4957]
  • Reattach existing subcommands from namespace to replacing command [#4951]
  • Convert ‘install’ to ‘installation’ [#4946]
  • Add sibling vendor folder location [#4938]
  • Check and display help command if requested [#4928]
  • Fix var_export return in WP_CLI::print_value [#4926]
  • Adapt README.md file for v2.0.1 release [#4924]
  • Bump version to 2.1.0-alpha [#4898]
  • Added cli cache prune & cli cache clear commands [#4787]


  • Add Savvii to hosting companies [#267]
  • Update hosting-companies.md [#266]
  • Update the set up and testing flow [#265]
  • History | grep = even better than ctrl-r [#263]
  • Please add One.com to the list [#261]
  • Add lima-city to hosting companies [#258]
  • Add plugin Simple History [#257]
  • Update running-commands-remotely.md to add ~/bin approach [#256]
  • Use “installation” instead of “install” [#255]
  • Fix issue with broken filename [#253]
  • Document root cause to STDOUT PHP notice [#252]
  • Update with v2 changes [#251]
  • Remove WP_CLI_Command class [#250]
  • Include the cron jobs in the governance document [#248]


  • Updated index.md – Spanish version [#316]
  • Adapt index.md file for v2.0.1 release [#315]


  • Rename transient list method to be consistent with other list commands [#49]
  • Introduce a list command to list all transients [#48]
  • Make output of transient type generic to include multisite behaviour [#47]
  • Replace usage of global with wp_using_ext_object_cache() [#45]
  • Improve deleting site transients [#42]


  • Use command namespaces instead of conditional addition [#54]


  • Permit use of wp config edit when WP isn’t functional [#71]
  • Use constant as default type when adding new keys [#80]
  • Add --format option for config get command [#79]
  • Use print_value() instead of log() for output of config get [#78]


  • Switch to wp-cli@dev [#92]
  • Adapt install => installation in tests [#90]
  • Fix tests for uncached nightly downloads [#100]
  • Adapt framework requirement [#101]


  • Make sure WP Cron is enabled for cron tests [#36]


  • Fix comment argument test [#127]
  • Adds --human-readable parameter to db size command [#124]
  • Support all mysql flags while importing database [#123]
  • Add search and delete example [#122]
  • Add new db clean to README.md and configuration files [#119]
  • Fix combination of --format & --size_format flags [#118]
  • Add links to mysql documentation [#117]


  • Update readme [#204]
  • Bump site meta test requirement to WP 5.1+ [#225]
  • Add missing --description flag logic for user create [#217]
  • Expose the available query variables for comment and post queries [#213]
  • Use “installation” instead of “install” [#212]
  • List all entities in the package description [#208]
  • Bail with a warning when deleting custom post types without --force [#188]
  • Add post exists command [#182]


  • Adapt install => installation in tests [#33]


  • Throw error in theme fetcher on non-lowercase slugs [#126]
  • Raise timeout for HTTP requests to 1 minute [#125]
  • Revert “Throw error in theme fetcher on non-lowercase slugs” [#137]
  • Failed plugin updates now throw errors [#143]
  • Use “installation” instead of “install” [#139]
  • plugin delete <plugin-name> not working if path has a space or & in it [#138]


  • Require framework as hard dependency [#78]
  • Add Composer config settings [#74]
  • Improve detection of translator’s comments [#101]
  • Improve regex replacement [#100]
  • Replace regexes Peast can’t parse [#99]
  • Allow skipping strings audit [#94]
  • Update file-comment argument docs [#93]
  • Set a placeholder PO-Revision-Date header [#92]
  • Remove ‘foo’ file [#88]
  • Include should override exclude instead of the other way around [#87]
  • Support parsing minified JS files created by WebPack [#85]
  • Add unit test cases for include/exclude options [#83]
  • Allow passing an empty file comment [#82]
  • Determine includes and excludes based on scores [#104]
  • Add parsing of .js.map files to improve reliability of JS translations [#103]
  • Remove second argument to WP_CLI::success() [#112]
  • Normalize paths [#111]
  • Normalize paths [#110]
  • Add i18n make-json command [#109]


  • Make sure upgrader strings are always in English [#54]
  • Slug fixes [#53]
  • Change access to activate_language() to private [#47]
  • Don’t error when a translation is not yet available [#69]
  • Check if array key exists to prevent undefined index notices [#67]
  • Support installing translations for all installed plugins/themes [#64]
  • Make use of report_batch_operation_results() for install commands [#63]
  • Continue if $available_updates is not a array [#62]
  • Add tests for wp site switch-language [#57]


  • Fix SVG regeneration test by adding an XML header to fake SVG file [#98]


  • Make tests work with both install and installation strings [#100]


  • Use forced width attribution as fallback only to avoid scrapping manual widths [#136]
  • Fix incorrect namespace for cli\notify\xxx [#137]


  • PHPCS template: fix XML error in ruleset [#171]
  • Add textdomain to block strings and update tests accordingly [#187]
  • Use branch for WP_TEST_TAG for RC and beta [#186]
  • Missing text domain in post_type_extended.mustache [#184]
  • Work around Travis CI issue with _s download certificate [#182]
  • Fix typo in Travis config [#180]
  • Ignore ‘node_modules’ in PHPCS XML file [#178]
  • Allow for installation as well as install [#177]
  • Fix syntax error in block-php.mustache [#176]
  • Inc ‘menu_position’ when scaffolding a post type [#173]
  • Remove Inflector Class [#172]
  • Run docker-php-ext-install with sudo -E in CircleCI [#188]
  • Split up the list of expected files to allow for WP 5.0+ changes [#195]


  • Corrects NULL export values. [#93]


  • Set SERVER_ADDR for the built-in webserver [#49]


  • Add regression test for #5 [#8]
  • Remove colloquialism [#6]
  • Preserve leading whitespace characters on config update [#5]
  • Fix regex for closing syntax in string [#9]
  • Use real config filename in Exception messages [#11]


Please give a big round of applause to these fine folks that have contributed their time and expertise to make this release possible: @abhijitrakas, @antigenius, @austinginder, @BhargavBhandari90, @birkestroem, @bitwombat, @bonny, @Calinou, @danielbachhuber, @dgroddick, @emirpprime, @fjarrett, @frozzare, @GaryJones, @Grucqq, @henrywright, @herregroen, @insomnux, @jrfnl, @KushibikiMashu, @markjaquith, @MoisesMN, @Mte90, @ocean90, @phillipp, @pmgarman, @rmccue, @siliconforks, @soulseekah, @swissspidy, @szepeviktor, @thrijith, @torounit, @tsmith1, @VladimirAus, @wojsmol, @yahilmadakiya, @yousan Thank you! ❤️

#release, #v2-1-0

WP-CLI v2.1.0 release postponed

The WP-CLI v2.1.0 release was originally scheduled for November 6th, 2018. However, due to the current timeline of the WordPress 5.0 release and the additional pressure it puts on all parties involved (WP-CLI contributors & testers included), I decided to postpone the release.

The new planned release date will be Tuesday, December 18th, 2018. This will keep it away from the planned release date(s) of WordPress 5.0 and place it shortly after the contributor day at WordCamp US, allowing us to get bug fixes & improvements done that day into the release as well.

For people who are waiting on getting their hands on the v2.1.0 release because of bugs in v2.0.1 that will be fixed, please note that you can always upgrade to the latest nightly release with the command wp cli update --nightly and switch back to stable releases later on with wp cli update --stable.

WP-CLI v2.0.1 Release Notes

A bugfix release was in order, as the new i18n make-pot command was not properly packaged in v2.0.0!

For this release, 9 contributors have produced 19 pull requests and squashed 12 bugs.

Breaking change

The only thing of note as a (potential) breaking change is “Throw error in theme fetcher on non-lowercase slugs” [#126]. It should turn scenarios that produce a success message and actually failed into error messages instead. However, given the many possible combinations of encodings and filesystem quirks, what should have failed might previously actually have worked out of sheer coincidence instead. This will now throw an error message nevertheless.

Complete change log


  • Add i18n-command dependencies to make-phar [#14]


  • Update dependencies and avoid redefining WP_CLI_ROOT [#4918]
  • Make pick_fields() work with numeric headers [#4916]
  • Automatically rerun failed scenarios [#4906]
  • Skip releases that lack a downloadable asset [#4923]


  • Permit use of wp config edit when WP isn’t functional [#71]


  • Update readme [#204]
  • Automatically rerun failed scenarios [#200]


  • Throw error in theme fetcher on non-lowercase slugs [#126]
  • Raise timeout for HTTP requests to 1 minute [#125]
  • Automatically rerun failed scenarios [#119]


  • Require framework as hard dependency [#78]
  • Add Composer config settings [#74]


  • Make sure upgrader strings are always in English [#54]
  • Slug fixes [#53]
  • Automatically rerun failed scenarios [#50]
  • Change access to activate_language()to private [#47]


  • PHPCS template: fix XML error in ruleset [#171]
  • Automatically rerun failed scenarios [#170]

Contributor List

@arunsathiya, @danielbachhuber, @javorszky, @jrfnl, @Mr-Alexander, @ocean90, @schlessera, @swissspidy, @wojsmol


WP-CLI v2.0.0 Release Notes

This is a big one! 67 awesome contributors have collaborated over 364 pull requests to bring you WP-CLI v2!

Before going over the detailed change log, let’s discuss a few key areas of this update in more detail. There’s also a “Breaking changes” further down in the document.

“Framework” & “Bundle” are now two separate packages

This is the main change we planned to include with version 2 of WP-CLI. From v2 onwards, the “framework” is a separate package from the “bundle” that is used to build the Phar file you can download. The framework is now contained within the wp-cli/wp-cli package, while the bundling has moved on to the wp-cli/wp-cli-bundle.

Agreed, this does not sound like such a big deal, but in terms of development experience and maintenance effort, it is a tremendous improvement, making almost every future change faster and simpler.

What does that mean for users working with the Phar version of WP-CLI ?

Nothing much, really. Apart from some of the debugging information containing different paths, you won’t see much of a difference. One of the goals was to not disrupt current usage more than necessary. If you only ever download the WP-CLI Phar and use that to control your sites, you should not need to care about this change.

What does this mean for site owners using WP-CLI through Composer ?

They will rejoice! The framework itself has gotten rid of most of its problematic dependencies. If you compare the dependencies of v1.5.1 with those of v2.0.0, you’ll see that the list is drastically shorter. Also, the most problematic set of the dependencies, the hard requirement on an old version of Symfony, is gone. The only Symfony component we still have (yet) is symfony/finder, as there’s no upper version limit for that one.

Most of the more problematic dependencies actually came from the WP-CLI package manager (wp-cli/package-command). That command is not only optional now, there’s also no valid reason to use it at all when pulling WP-CLI in via Composer directly.

This also means that you will not see WP-CLI automatically pull in all bundled commands automatically. Let’s say, you need the wp-cli/db-command for some maintenance tasks for your site. With v1.5.1, this would have pulled in the entire WP-CLI bundle as a dependency. With v2.0.0, it will only pull in the lean framework as a dependency, nothing more. You’ll end up with a WP-CLI active on your site that contains the commands clihelp (as the two “built-ins”) and db.

As a nice side-benefit, this makes WP-CLI run much faster in such scenarios, as it only loads what is effectively needed for the site. The difference might not seem like much, but depending on how you use in in your scripts, it can make a big difference.

What does this mean for developers working on third-party WP-CLI commands?

Splitting everything up has provided a few additional perks for developers (see also the next section about the testing improvements). Everything is leaner, and the dependency resolutions are less problematic, as we got rid of that one nasty circular dependency (command requires framework => framework equals bundle => bundle requires command).

However, dependency declarations need to be more explicit now. If you require wp-cli/wp-cli, this will only provide the pure framework. You cannot implicitly rely on any of the bundled commands in that case, you’ll have to explicitly require any additional command you might need.

Testing framework is now a separate package

One of the things that bothered me a lot while maintaining WP-CLI was the fact that the testing infrastructure was “scaffolded” into the individual command packages (just as it is into the third-party commands). This basically means that we copy-pasted the code in there, and if the code needs to change (because of a bug being fixed or an improvement being made), we have to create changes in every single package to overwrite the copy-pasted version of the testing code with an updated one.

Now we have the testing infrastructure abstracted away into a separate package: wp-cli/wp-cli-tests. For this first iteration, it includes out-of-the-box support for PHP linting, PHP Code Sniffer checks (including the WordPress Coding Standards and the PHP Compatibility Checks), PHPUnit unit tests and Behat functional tests. They are set up in such a way that they detect whether they should run, based on config files or test files presence.

A simple composer test will run all of the tests in order. But you can also run them individually, through composer lint|phpcs|phpunit|behat. Adding further configuration flags can be done as well, but you need to remember to prepend them with a double-dash ( --) first, otherwise the arguments will be interpreted by Composer itself.

For the most important tests, the functional Behat tests, you can also define some constants to adapt the environment in which to test. For example, testing against a specific version of WordPress can be done by providing the WP_VERSION constant: WP_VERSION=4.2 composer behat. This constant also understands latest and trunk correctly.

In general, the tests are set up in such a way that you’ll face less differences between what you get locally and what you’ll get inside of the Travis CI checks.

And given that the tests can now be worked on in one central location, we’re already thinking about what our next steps are to further improve them, like letting you easily re-run only the failed scenarios from last run or automatically retrying failures on Travis to make sure it was not a random intermittent timeout or similar.

New command: i18n make-pot

@swissspidy has spent countless hours working on a new command that has now finally made it into the official WP-CLI bundle. We now introduce you to the i18n command family and its first usable subcommand, i18n make-pot.

What started out as an exploration at first is now a robust tool that is already being used in production systems and is even planned to replace the default translation tool bundled with WordPress Core. It supports both PHP and JavaScript, can manipulate and put into shape multiple files and even detected bugs in the original Core tooling.

This can now easily be including in whatever automated tooling you use for your site/plugin/theme development, and should make your translation work much smoother. Here’s a quick rundown of the main features:

  • Automatically detects plugins and themes and extracts file headers.
  • Allows extraction of only a specific text domain.
  • Supports JavaScript string extraction, even for JSX and ESNext.
  • Allows merging the resulting POT file with an existing one, e.g. one created by Babel.
  • Powerful rules to include/exclude specific directories (minified JS files, vendor, .git folder, etc.).
  • Supports extracting strings from WordPress core the same way it’s done today with 4 different projects. See https://github.com/wp-cli/i18n-command/pull/69 for examples.
  • Can warn about strings with wrong placeholders, as well as misleading or missing translator comments. This could be very useful for core but also plugin/developers to improve polyglots UX.

A big shoutout to @swissspidy for the fabulous work he did on that command!

Minor Framework enhancements

New WordPress action: 'cli_init'

We introduced a new action 'cli_init' that will be triggered by WP-CLI during the 'plugins_loaded' action. This can be used as a conditional trigger for loading WP_CLI specific code, in case you don’t want to use the constants we already provide, for whatever reason.

This being a WordPress action, it adds a bit more flexibility to the process of loading a WP-CLI command, like for example one plugin being able to unhook the commands of another plugin.

New command: config edit

Easily open your wp-config.php in your favorite editor (configured through the EDITOR environment variable). Once you save within that editor, the wp-config.php will be correctly updated.

Note: This works through SSH/vagrant/docker tunnels as well, but keep in mind that it will use the EDITOR of the remote system, which should be something like vim (=> “how to exit the vim editor” 😉).

# Launch system editor to edit wp-config.php file
$ wp config edit

# Edit wp-config.php file in a specific editor
$ EDITOR=vim wp config edit

New command: config shuffle-salts

This refreshes the salts stored in your wp-config.php file, which are cryptographic values used for authentication and other security-related functionality. Regulary refreshing these salts could be considered “security hygiene” for a site.

The command will generate the salts locally if your PHP server environment is cryptographically secure enough to do so, and falls back to the remote wordpress.org API endpoint if not.

# Get new salts for your wp-config.php file
$ wp config shuffle-salts
Success: Shuffled the salt keys.

New command: db columns

Get a tabular view of the table schema for a given table. It shows you how the individual columns of the table have been defined, which default values they use and what extra functionality might be attached to them.

$ wp db columns wp_posts
|         Field         |        Type         | Null | Key |       Default       |     Extra      |
| ID                    | bigint(20) unsigned | NO   | PRI |                     | auto_increment |
| post_author           | bigint(20) unsigned | NO   | MUL | 0                   |                |
| post_date             | datetime            | NO   |     | 0000-00-00 00:00:00 |                |
| post_date_gmt         | datetime            | NO   |     | 0000-00-00 00:00:00 |                |
| post_content          | longtext            | NO   |     |                     |                |
| post_title            | text                | NO   |     |                     |                |
| post_excerpt          | text                | NO   |     |                     |                |
| post_status           | varchar(20)         | NO   |     | publish             |                |
| comment_status        | varchar(20)         | NO   |     | open                |                |
| ping_status           | varchar(20)         | NO   |     | open                |                |
| post_password         | varchar(255)        | NO   |     |                     |                |
| post_name             | varchar(200)        | NO   | MUL |                     |                |
| to_ping               | text                | NO   |     |                     |                |
| pinged                | text                | NO   |     |                     |                |
| post_modified         | datetime            | NO   |     | 0000-00-00 00:00:00 |                |
| post_modified_gmt     | datetime            | NO   |     | 0000-00-00 00:00:00 |                |
| post_content_filtered | longtext            | NO   |     |                     |                |
| post_parent           | bigint(20) unsigned | NO   | MUL | 0                   |                |
| guid                  | varchar(255)        | NO   |     |                     |                |
| menu_order            | int(11)             | NO   |     | 0                   |                |
| post_type             | varchar(20)         | NO   | MUL | post                |                |
| post_mime_type        | varchar(100)        | NO   |     |                     |                |
| comment_count         | bigint(20)          | NO   |     | 0                   |                |

New command: db clean

We already had db reset, but that dropped the entire database… which is not a nice thing to do if there’s more than a default WordPress site in there 😱!

The new db clean will only drop the tables that are actually part of the current WordPress installation and leave the rest of the database instance intact.

# Delete all tables that match the current site prefix.
$ wp db clean --yes
Success: Tables dropped.

New command: site meta

We’ve added CRUD methods adddeletegetlistpatch, pluck and update for the “site meta” entities.

Oh, and while you are wondering… Yes, you are right, WordPress does not have “site meta” entities. But we didn’t lose our minds: WordPress will introduce “site meta”, together with a wp_site_meta table, with its 5.0 version. We just like to be prepared, that’s all… 😜

# Set site meta
$ wp site meta set 123 bio "Mary is a WordPress developer."
Success: Updated custom field 'bio'.

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

# Update site meta
$ wp site meta update 123 bio "Mary is an awesome WordPress developer."
Success: Updated custom field 'bio'.

# Delete site meta
$ wp site meta delete 123 bio
Success: Deleted custom field.

New command: user check-password

You can now let WordPress tell you whether a given password is valid for a specific user. This is NOT an endorsement to build your authentication layer with Bash scripts! But who knows what exotic automation needs the DevOps folks will come up with…

The command will let you know through a shell exit code whether the password was valid or not, so you can use it directly in if conditionals.

# Check whether given credentials are valid; exit status 0 if valid, otherwise 1
$ wp user check-password admin adminpass
$ echo $?

# Bash script for checking whether given credentials are valid or not
if ! $(wp user check-password $USER $PASSWORD); then
    notify-send "Invalid Credentials";

New commands: language plugin and language theme

They both come with the following subcommands: install, update, uninstall, list and is-installed (which was added to core language as well).

You can now fully control all of the language files of your installation individually.

# Install the Dutch theme language pack.
$ wp language plugin install hello-dolly nl_NL
Success: Language installed.

# Uninstall the Dutch theme language pack.
$ wp language plugin uninstall hello-dolly nl_NL
Success: Language uninstalled.

# List installed theme language packages.
$ wp language plugin list --status=installed
| language | english_name | native_name | status | update | updated |
| nl_NL | Dutch | Nederlands | installed | available | 2016-05-13 08:12:50 |

Changes to existing command

  • db size now knows about ISO size units as well
  • option list got a new --unserialize flag
  • post generate can now deal with --post_date_gmt
  • user update now allows you to --skip-email
  • eval-file can read from STDIN
  • Both plugin uninstall and plugin delete can now act on --all plugins at once
  • cap list can now --show-grant
  • cap add , seeing what its list sibling had done, grew a new --grant flag
  • role list can now print a single --field=<field>
  • scaffold _s learned the new --woocommerce trick
  • search-replace lets you set a --regex-limit

Automated README.md updates

If you have ever contributed to WP-CLI and made a change to a command signature or documentation, you probably had me tell you that you needed to regenerate the README.md as well using the wp scaffold package-readme . --force command. No more!

We have now added a package wp-cli/regenerate-readme that automates this process. It adds both a precommit and a postcommit git hook that collaborate to transparently regenerate the README.md file behind the scenes and then amend your commit to add the required changes automatically.

This has not been deployed to all command packages yet while we still experiment with some of the finer points of its implementation, but you’ll slowly see the annoying “please regenerate README.md kthxbye” reminders from my side disappear and become forgotten artifacts of the past.

Improved debug output

The debug output was always a bit sparse for WP-CLI. This is why we took the opportunity of v2 to improve upon it and make it more useful. It will now add debug messages for the hooks that are triggered, or details about how commands are being loaded or deferred. This will be very useful for third-party command developers that ignore why their command is not properly registered.

We’ll make sure to add even more useful debugging information in the future.

Small side note: To make debugging work as early as possible, it is now smart enough to just store all messages until the logger it needs to send them to becomes available. This means you don’t need to worry about the timing here, if the WP_CLI exits for your code, the debugger is good to go!

Breaking changes

Here are a few things you need to be aware of when moving from ^v1 to ^v2:

  • An obvious breaking change is the bump to the minimum version of PHP. This will break for anyone trying to run WP-CLI on PHP 5.3.
  • The separation of the “framework” and the “bundle” into two separate packages will cause a breaking change if a third-party command is being pulled-in via Composer AND that third-party command relies on running bundled commands as well. This will seldom be the case and will be an easy fix. Installations using the Phar will not be impacted.
  • As many dependencies could be removed from the framework by not including the package manager automatically, any third-party command that relies on one of the removed Symfony packages or other dependencies AND hasn’t declared that requirement in its own Composer configuration will break. This will seldom be the case and will be an easy fix. Installations using the Phar will not be impacted as the package manager still comes with these requirements included.
  • The versions of some the dependencies will be bumped. If you happen to not lock WP-CLI into a specific version constraint, but do so for some of its dependencies, you might see a version constraint conflict when using Composer.
  • Any external code that relies on internal file structure, file naming or other internal details that are not part of the provided API could run the risk of breaking due to us moving things around from v1 to v2. This should hopefully not ever be the case, but you never know…
  • As a side-effect of adding the --all flag to plugin uninstall, a breaking change was introduced for consistency reasons. Whereas WP-CLI used to consider uninstalling a non-existent plugin as a “Success: Plugin already uninstalled”, it will now throw an error “Error: No plugin uninstalled”.
  • We did our best to avoid unnecessary breaking changes. But with a big structural change like we have here, the devil’s in the details. Let us know if you hit any other issues!

Complete change log


  • Bundle wp-cli/i18n-command [#9]


  • Add Inflector class and convenience function for pluralizing nouns [#4881]
  • Adapt regular expression in make-phar test to skip wiki links [#4873]
  • PHPCS Config Refresh [#4867]
  • Fix PHP version check [#4864]
  • Trigger new 'cli_init' hook during WordPress 'plugins_loaded' action. [#4861]
  • add template for core-command to phar [#4854]
  • Fall back to full string instead of $mode on PHP < 7 [#4853]
  • Refactoring wp-cli/wp-cli to represent the framework only, not the bundle [#4851]
  • Remove WP 4.4 requirement [#4845]
  • Fix —skip-theme tests [#4843]
  • Fix shell scripting issues in ci/deploy.sh [#4842]
  • Fix shell scripting issues in bin/wp [#4841]
  • Additional quoting in ci/prepare.sh [#4840]
  • Lock wp-completion.bash to v1.5.1 [#4839]
  • Remove Gemnasium badge, as the service was shut down [#4815]
  • Use latest search-replace package to fix tests broken due to privacy policy change [#4807]
  • Turn 'latest' into version number [#4806]
  • Update packages to fix broken tests due to WP5.0 [#4804]
  • Switch to fixed package command [#4803]
  • Bump lowest PHP version to test to 5.4 [#4798]
  • Add a missing accepted output format to wp cli alias [#4765]
  • Improve the descriptions of the --skip-plugins and --skip-themes flags [#4759]
  • Include sublinks in README.md to popular installation methods [#4756]
  • ABSPATH defined [#4743]
  • Skip wp_blogmeta table for back compat [#4736]
  • Introduce \WP_CLI\Utils\normalize_path function. Using it for ABSPATH constant. [#4718]
  • Undo temporary one-off @require-php-5.4 in bootstrap test. [#4716]
  • Revert “Require minimum PHP 5.4” [#4715]
  • Skip pre-commit hook in auto-composer-update [#4711]
  • Revert “update wp cli info” [#4702]
  • Remove : from cli update info check. [#4697]
  • Only check staged files during the pre-commit PHPCS verification [#4696]
  • Empty domain in framework test after get_sites_by_path change. [#4695]
  • Append uniq_id() when extracting file from Phar [#4692]
  • Support launching system editor with specific temp file extension [#4691]
  • Script to create the Git pre-commit hook. [#4622]
  • Update wp cli info [#4613]


  • Add documentation on how to troubleshoot [#243]
  • Use <example.com> as placeholder [#242]
  • Fix typos in <code-review.md> [#239] & [#241]
  • Remove Dead Link [#238]
  • Update docs for installing WP-CLI via brew [#236]
  • Add quotes to the alias [#235]
  • Adapt signing procedure to use proper key [#232]
  • Added the optimize WP CLI command of the WP-Optimize Plugin [#231]
  • Add an updraftplus WP CLI command [#228]
  • Fix grammar in documentation paragraph [#226]
  • Add a LICENSE file to the repo [#224]
  • Incorporate a few strategic mentions of the wp-cli/ideas repo [#223]
  • Remove the wish list from the website [#222]
  • Document WP_CLI_PHP_ARGS in WP-CLI config document [#221]
  • Mention the Docker installing method [#220]
  • Document issue of creating a post with Latin characters in title [#214]
  • Add BOM in wp-config.php as a common issue. [#212]
  • Add WP_CLI_PHP to Environment variables [#211]
  • Fix missing quote in documentation [#210]
  • Separate non-bundled install; generate against current WP-CLI instance. [#207]
  • Update Daniel’s relationship to the project [#206]


  • Updated <index.md> for Spanish language [#313]
  • Remove Gemnasium badge [#312]
  • Update pt_BR translation [#311]
  • Add a LICENSE file to the repo [#309]
  • Add note about only using the English version as source for translations [#308]
  • Translate homepage into Spanish [#307]
  • Changed http to https in all wp-cli.org links. [#305]


  • Package is now obsolete as of v2.0.0


  • Adapt package for framework v2 [#32]


  • Make soft changes more flexible for plugin checksums [#43]
  • More flexible soft change checks (issue #34) [#41]
  • Add backslash to the regex for matching Windows paths correctly [#39]
  • Scaffold correct GitHub labels [#37]
  • Adapt package for framework v2 [#50]


  • Fix library version to ^1.2.1 [#53]
  • Removed leftover remove() operation [#52]
  • Introduce config edit command [#48]
  • Add higher timeout config value [#67]
  • Adapt package for framework v2 [#66]
  • Ensure file_put_contents() writes to the wp-config.php path [#63]
  • Add shuffle-salts command [#62]
  • Set WP_CACHE_KEY_SALT [#59]


  • Bring template files over from wp-cli/wp-cli [#73]
  • Fix mustache template file path [#77] & [#78]
  • Sanitize database at the end of install to prevent duplicate data [#76]
  • Adapt package for framework v2 [#81]


  • Adapt package for framework v2 [#29]


  • Add db columns command [#100]
  • Count users instead of posts for the smoke test [#98]
  • Fix test failure due to introduction of wp_blogmeta table [#94]
  • Add db clean command [#93]
  • Add examples for exporting certain posts [#90]
  • pass --column-statistics=0 to mysqldump command [#105]
  • Add ISO size formats to db size [#104]
  • Adapt package for framework v2 [#110]


  • Adapt package for framework v2 [#38]
  • Scaffold missing top-level commands [#35]


  • Fix tests after Core’s introduction of a default “Privacy Policy” page [#177]
  • Abstract meta CRUD into methods [#174]
  • Remove duplicative --user_email=<user-email> argument [#173]
  • Turn latest into actual version number [#171]
  • Improve the formatting of various format parameter documentation [#168]
  • Add site meta sub-command [#159]
  • Add --unserialize flag to option list command [#156]
  • Add --from-post=<post_id> flag to create duplicate posts [#154]
  • Properly clone objects for comparison [#152]
  • Fix missing quote in documentation [#147]
  • Fix category list count [#146]
  • Add user check-password subcommand [#144]
  • Replace ‘install’ to ‘installation.’ [#187]
  • Add support for --post_date_gmt in post generate [#184]
  • Optional --skip-email flag for wp user update [#155]
  • Adapt package for framework v2 [#192]


  • Adapt package for framework v2 [#27]
  • Support eval-file from STDIN (implementation for #19) [#21]


  • Start with an empty site to avoid count issues [#36]
  • Adapt package for framework v2 [#44]


  • Add missing templates to this repository [#107]
  • Replace retired themes used in tests with new ones [#105]
  • Introduce theme mod list [#100]
  • Refresh README.md and test suite prior to v1.1.10 release. [#89]
  • Allow for modern-wordpress redirect [#85]
  • Add --all flag for plugin uninstall command [#84]
  • Fix mustache file paths [#109] & [#112]
  • Search: Add plugin or theme’s URL on <wordpress.org> [#108]
  • Add --all flag to plugin delete [#103]
  • Adapt package for framework v2 [#116]


  • Prepare for v2 release [#72]
  • WordPress Core support [#69]
  • Check for more mistakes in translatable strings [#64]
  • Separate translation extraction from Po file writing [#63]
  • Make PhpFunctionsScanner extensible [#62]
  • Separate command argument handling from actual __invoke() [#60]
  • Add --headers parameter [#58]
  • Add X-Generator header to POT file [#57]
  • Print some more helpful debug messages [#56]
  • Factor directory iterator as a trait [#54]
  • Text domain header [#43]
  • Add @when before_wp_load to command namespace [#42]
  • Add option to extract strings with any text domain [#38]
  • Correctly pass exclude option to JsCodeExtractor [#37]
  • Add warning when a string has two different translator comments [#34]
  • Exclude some common directories [#32]
  • Add ability to merge with existing POT file [#31]
  • JavaScript String Extraction [#26]
  • Don’t try to extract anything when there are no PHP files [#24]
  • Add more tests related to translator comments [#23]
  • Standardize file names [#21]
  • Extract all supported functions. [#13]


  • Adapt post/page generation to make them resilient to added privacy policy page [#25]
  • Adapt package for framework v2 [#30]


  • Revert “Add plugin and theme command” [#28]
  • Adapt package for framework v2 [#43]
  • Use download_url() in language pack upgrader [#41]
  • Enable updating languages for individual plugins and themes [#40]
  • Warn if no plugin or theme has been specified [#38]
  • Add is-installed command to check if a given language is installed [#36]
  • Update language core update --dry-run message [#32]
  • Add language plugin and language theme command. [#29]


  • Adapt package for framework v2 [#85]
  • Update examples in documentation [#81]
  • Reinstate ghostscript/imagick install and fix bmp name in regenerate test. [#69]
  • Document how to fetch attachment URL after import [#68]
  • Clear WP object cache periodically on media regenerate/import. [#62]


  • Assume default package name if composer.json file cannot be retrieved [#78]
  • Avoid using Composer CA bundle if in phar. [#73]
  • Move test-command to wp-cli-test Github organization [#66]
  • Extract SSL certificate from Phar first before using it in Composer [#83]
  • Adapt package for framework v2 [#87]
  • Exclude broken Composer version [#91]


  • Remove double semi-colon [#130]
  • Fix potential endless loop in prompt() [#129]
  • Fix off-by-1 error in progress bar examples [#128]
  • Add optional $msg parameter to cli\Progress\Bar::tick() [#126]


  • Adapt package for framework v2 [#20]


  • add --show-grant argument to wp cap list and --grant to wp cap add [#19]
  • Add --field=<field> support to listing roles [#17]
  • Adapt package for framework v2 [#23]


  • Skip PHPUnit tests for PHP 7.2+ [#145]
  • Modify scaffold block to create index.js [#142]
  • Fix theme-specific paths in scaffolded blocks [#137]
  • Add PHP 7.2 to CI templates [#135]
  • Exclude tests/test-sample.php via the phpunit.xml.dist file [#134]
  • Fix sed -i option on MacOS [#132]
  • Use correct default $WP_TESTS_DIR on MacOS [#131]
  • Use phpunit 6.5.6 for PHP 7.2 to get around core test incompat. [#125]
  • Fix WPCS in theme-tests generation [#121]
  • Switch CircleCI template to CircleCI 2.0. [#115]
  • Correct 'add_new_item' label [#163]
  • Exclude string from escape warning [#162]
  • Update PHPCS default rule set [#161]
  • Add --woocommerce flag to scaffold _s command [#159]
  • Add PHPCompatibility sniffs to scaffolded [#154]
  • Add escaping for block title [#153]
  • Remove 'wp-blocks' from style dependency [#151]
  • Add function_exists() check to block PHP template [#147]
  • Adapt package for framework v2 [#166]


  • Fix tests that are broken due to the addition of a “Privacy Policy” page [#78]
  • Handle incomplete class (un)serialization gracefully [#76]
  • Handle PCRE errors gracefully [#75]
  • Remove “Site Not Found” message from multisite usage [#69]
  • Fix broken GUID test [#81]
  • Improve --regex-limit logic [#70]
  • Adapt package for framework v2 [#86]
  • Add --regex-limit option. [#62]


  • Adapt package for framework v2 [#42]


  • Adapt package for framework v2 [#25]
  • Better explain the --basic flag [#23]


  • Adapt package for framework v2 [#19]


Here’s the complete list of the fantastic folks that have helped make this happen:

@2020media, @abhijitrakas, @ajitbohra, @alpipego, @austinginder, @benlk, @BhargavBhandari90, @burhandodhy, @chesio, @CodeProKid, @danielbachhuber, @drzraf, @emirpprime, @ericgopak, @erlendeide, @felicianotech, @felipeelia, @fumikito, @GaryJones, @ghost, @gitlost, @greatislander, @JanVoracek, @janw-oostendorp, @javorszky, @jblz, @jmichaelward, @johnbillion, @josephfusco, @kirtangajjar, @kshaner, @lalaithan, @lf-jeremy, @libertamohamed, @marcovalloni, @marksabbath, @miya0001, @MoisesMN, @montu1996, @NicktheGeek, @ocean90, @pdaalder, @pekapl, @pixolin, @pjeby, @pmbaldha, @ptrkcsk, @ryanjbonnell, @sagarnasit, @salcode, @sasagar, @schlessera, @spacedmonkey, @spicecadet, @stevegrunwell, @strandtc, @svenkaptein, @swissspidy, @terriann, @thrijith, @tiagohillebrandt, @tomjn, @torounit, @wojsmol, @wp-make-coffee, @yousan, @zipofar

A big thank you to all involved! ❤️

#release, #v2-0-0

WP-CLI v2.0.0 release postponed

The upcoming WP-CLI release v2.0.0 that was originally due to be released on July 31st is being re-scheduled for Wednesday, August 8th.

This delay is due to the fact that it was much more work to disentangle the feature tests to split them up for the restructuring. I want to avoid hurrying the release, so I prefer to add some more time to let the dust settle and run further tests.

Thanks for your patience!

WP-CLI Hack Day Results

The first WP-CLI Hack Day is over now and it was a great success! It created an entirely new level of interactivity to the process.

I’d like to say “Thanks!” to everyone that participated! ❤️ It was awesome to help people get set up and then see the pull requests rolling in!

Here’s a quick rundown of what we were able to achieve, and the problems we faced.

We had 12 pull requests that were merged during the event:

  1. wp-cli/scaffold-command – Add --woocommerce flag to scaffold _s command
  2. wp-cli/handbook – Remove dead link
  3. wp-cli/handbook – Fix typo
  4. wp-cli/handbookFix typo in code-review.md
  5. wp-cli/wp-config-transformer – Remove colloquialism
  6. wp-cli/language-command – Add is-installed command to check if a given language is installed
  7. wp-cli/handbookUse example.comas placeholder
  8. wp-cli/core-command – Sanitize database at the end of install to prevent duplicate data
  9. wp-cli/core-command – Fix mustache template file path
  10. wp-cli/extension-command – Fix mustache files paths
  11. wp-cli/scaffold-command – Exclude string from escape warning
  12. wp-cli/wp-cli – Trigger new 'cli_init' hook during WordPress 'plugins_loaded' action

In addition to that, we had another 13 pull requests that were submitted during the event but could not yet be merged:

  1. wp-cli/extension-command – Search: Add plugin or theme’s URL on
  2. wp-cli/wp-cli – Add template for core-command to phar
  3. wp-cli/wp-cli – Add templates for extension-command to phar
  4. wp-cli/scaffold-command – Change to .phpcs.xml.dist and update rules
  5. wp-cli/db-command – Pass --column-statistics=0 to mysqldump command
  6. wp-cli/db-command – Add db size size formats
  7. wp-cli/entity-command – Detect post_content if STDIN
  8. wp-cli/entity-command – Delete alert in case of custom post type
  9. wp-cli/config-command – Add shuffle-salts command
  10. wp-cli/wp-cli-tests – Move PHPUnit tests for behat-tags.php over
  11. wp-cli/scaffold-package-command – Update circle.yml to use its v2 API
  12. wp-cli/dist-archive-command – Update circle.yml to use its v2 API
  13. wp-cli/handbook – Add documentation on how to troubleshoot

The main reason why most of these were not merged during the event was that we had trouble with our automated tests. One problem was that many tests that depended on the WordPress.org infrastructure to download Core files, plugins or themes had frequent timeouts. This seems to be caused by a recent move of the entire infrastructure, which made access to the content over CDN very spotty. Another problem was that Travis CI was acting up and was often stuck in “pending” state for prolonged time periods.

During the last two hours of the event, we did a video chat over Zoom with all participants that wanted to join. We peaked at 13 participants to that video chat. It allowed for people to make a more personal connection, which added another dimension to the act of contributing.

There was an official hashtag for the event: #hackwpcli. See all mentions of the hashtag #hackwpcli on Twitter. However, I initially messed up the hashtag and pointed people to the wrong one, so some tweets have been tagged with #hackthecli instead. 🤦‍♂️

We had an ambitious goal of merging 20 pull requests during the event. While we were not able to achieve that number of merged pull requests, I’d consider the event a complete success nevertheless, considering the amount of pull requests that were just waiting to get through the blocking tests to get merged.

The event was also an experiment, to see whether a more direct, interactive form of contribution would attract more contributors. I think it did succeed in doing so, and I think it was a positive experience for the participants.

👉 I would love for people to provide feedback about the event in the comments below. 👈

I’d like to evaluate how well this type of contribution event was received and this will then shape a possible next iteration, where we’ll hopefully get even Travis & Co. to collaborate.


Details on the upcoming major release

The upcoming major release of WP-CLI v2.0.0 is scheduled for July 31st, 2018.

The release cycle has been a bit longer to account for the fact that some major changes are happening behind the scenes. This is what you can expect from the upcoming release:

  • PHP version minimum will be bumped to PHP 5.4, as already announced in December (see #4554).
  • Repository/package restructuring to separate the framework and the bundle that combines the framework with the default commands into separate packages (see #4748).
  • Removal of the Symfony dependencies from the framework package, to avoid conflicts in Composer setups (see #4749).
  • Convenience access to common contributor actions, through Composer scripts (see #4167).
  • A new standardized way of working on WP-CLI as a whole (see #4750).
  • Automate redundant work like regenerating README.md files (see #4751).
  • A new family of commands wp i18n for all your internationalization needs, brought to you by @swissspidy (see #4808 and wp-cli/i18n-command).
  • All of the small changes and bugfixes that we have been collecting since the v1.5.0 release, as most of this was skipped for v1.5.1 to keep that release “bug-fix-only”.
  • Anything we might get production-ready during the upcoming WP-CLI Hack Day!

With the above restructuring, you should expect some breaking changes, most notably:

  • #4554 will cause a breaking change for anyone trying to run WP-CLI on PHP 5.3.
  • #4748 will cause a breaking change if a third-party command is being pulled-in via Composer AND that third-party command relies on running bundled commands as well. This will seldom be the case and will be an easy fix. Installations using the Phar will not be impacted.
  • #4749 will cause a breaking change if a third-party command relies on one of the removed Symfony packages AND hasn’t declared that requirement in its own Composer configuration. This will seldom be the case and will be an easy fix. Installations using the Phar will not be impacted as the package manager still comes with these requirements included.
  • The versions of some the dependencies will be bumped. If you happen to not lock WP-CLI into a specific version constraint, but do so for some of its dependencies, you might see a version constraint conflict.
  • Any external code that relies on internal file structure, file naming or other internal details that are not part of the provided API could run the risk of breaking due to us moving things around from v1 to v2. This should hopefully not ever be the case, but you never know…




Contributing to WP-CLI

Drawing of female freelancer sitting in front of their laptopDoes WP-CLI save you effort and time while working on the sites you manage?
Do you use WP-CLI to automate your infrastructure or deployments?
Do you feel positive about the WP-CLI project and its mission?
This guide will tell you about the many possibilities you have to get involved and play a role in this official WordPress team.


First of all, thank you very much! If you’ve read this far, it must mean you are taking the initiative to contribute to WP-CLI. It’s because of you, and the community around you, that WP-CLI is such a great project. It not only makes for a fabulous tool people can use in a reliable manner, it also makes for a fun and rewarding project to collaborate on.
Contributing can take many forms, and we will discuss the most prominent ones. Before we start, though, here’s a list of what contributing is not:
  • Contributing is not limited to code.
  • Contributing does not require committing to a specific amount of time.
  • Contributing does not require expert knowledge in any of the areas it touches.
Drawing of a man hanging from a rope to work on a computer.We encourage you to contribute in the way that best fits your interests and abilities. If at any point, you’re not sure how to proceed with whatever you are doing or feel you’re in over your head, help & support is just a chat message away! Please don’t hesitate at any point to just ask questions or let us know about the issue you’re facing.
Also, please do know that there are no expectations you need to fulfill or requirements you need to meet. This is meant to be an enjoyable, collaborative experience. So make sure you don’t put pressure on yourself and rectify your course of action if you feel that you’re not actually enjoying it anymore.
Now, with that clarification out of the way, let’s try to cover some of the most common ways of contributing to WP-CLI.

Spreading the message

Drawing of a woman watering plants that look like social media network logos.Not everyone knows about WP-CLI or how it can help improve how you interact with a WordPress site.
There are multiple ways of how you can help spread the message about WP-CLI:
  • Post clever uses as tips to social media (tagging @wpcli on Twitter is always appreciated).
  • Submit conference talks about usage and best practices.
  • Publish tutorials on your blog.
  • Give a demo at your local meetup.
Note: You can request free stickers to distribute at events → read about the requirements.

Supporting users

Drawing of a typing indicator in a chat system.A great way to learn more about WP-CLI yourself and to help other people make progress is to jump into one of the support channels and try to answer questions other people have posted. Doing the detective’s work, understanding how the moving pieces work and finally getting to the bottom of a user’s problem can be very rewarding, and you learn all kinds of internal details along the way.
There are three main avenues where people can request support:
Any open issue/question/thread you can find in these locations are open for anyone to contribute an answer or to ask further questions to help diagnose the issue.

Improving documentation

Drawing of a woman filing notes.Is documentation your strength? Take a look at the currently open documentation issues and see if you can tackle any of those, or create a new issue if you’ve read through the documentation and found it lacking in a specific area.
There are a couple different types of documentation currently part of WP-CLI:
  • Documentation for individual WP-CLI commands (anything underneath developer.wordpress.org/commands) is contained in the PHPDoc for each command. This means that to edit the documentation for a command, you will need to edit the file that actually provides the functionality for that command. The web documentation is generated from these files at the time of release, so you may not see your changes until the next release.
  • Individual documentation pages (anything under make.wordpress.org/cli/handbook) can be edited by contributing to the handbook repository on GitHub. You don’t necessarily need to navigate the Github repo though; any page that is part of this repository will have an Edit link in the top right of the page which will take you to the corresponding file on GitHub. Just clicking on that link brings you to a live editor which will generate a pull request out of your changes.


Drawing of multiple windows showing the same basic content.WP-CLI is in a special position when it comes to localization. Its main output is not supposed to be localized, as it is used for scripting purposes. If your scripts depend on a given string to be printed to the console, translating that string into a different language will, of course, break these scripts.
What should be translated, though, is the different types of documentation we have. Unfortunately, we are currently lacking the infrastructure support on make.wordpress.org/cli to properly support translated versions of the handbook or command reference.
What can be translated right now and is open for contributors is the README file shown as the frontpage on wp-cli.org. The different language versions can be found in subfolders in the wp-cli/wp-cli.github.com repository. Please use the English source version as the reference source, as it is the only one to be guaranteed to be up-to-date at any time.

Reporting security issues

Drawing of a man manipulating a security shield.Don’t publicly disclose a security issue you’ve just found!
The WP-CLI team and the WordPress community take security bugs seriously. We appreciate your efforts to responsibly disclose your findings and will make every effort to acknowledge your contributions.
To report a security issue in a responsible way, please visit the WordPress HackerOne program. You will be able to submit details about the security vulnerability in a confidential way, to avoid malicious users immediately exploiting the vulnerability on live sites. You will be contacted by the WordPress security team about next steps as soon as possible.

Reporting a bug

Drawing of a computer screen showing an alert.Think you’ve found a bug? We’d love for you to help us get it fixed.
Before you create a new issue, you should search existing issues (*) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version of WP-CLI. You should also check our documentation on common issues and their fixes.
Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please follow our guidelines for submitting a bug report to make sure it gets addressed in a timely manner.

Requesting a new feature

Drawing of a man rearranging post-its on a whiteboard.To request a new feature, please create a new issue in the issue tracker of the wp-cli/ideas repository.
This is the very first step that any new functionality should take. It will be further fleshed out within this issue until a decision has been made about whether the feature is a good fit for the official WP-CLI bundle and how the technical implementation should be handled. At that point, the issue will move into the repository where its code will finally reside.

Working on the code

Before you can start writing code, you need to decide what you plan on working on.
  • Good first issues
    To get your feet wet with working on the WP-CLI codebase, you should star with one of the issues that are marked as good-first-issues. These issues usually require less historical knowledge and are very limited in scope and complexity. Often times, you’ll find the proper approach to solve the issue directly explained within the issue conversation.
  • Fixing a bug
    Even though we spend a lot of time writing tests and reviewing code, we cannot completely avoid bugs in a codebase of this complexity.
    If you want to see a list of known bugs and help fix them, you can use this GitHub search (*).
  • Implementing a new feature
    You can find the collection of submitted feature requests in the issue tracker of the wp-cli/ideas repository. There are labels that define what the current state of a feature request is:
    • state:approved: This feature request has already been accepted in principle and only needs someone that can invest the time to make it happen.
    • state:considering: This feature request seems to be useful and a good fit for the project, but additional discussion and fleshing out is needed before a final decision can be made.
    • state:unlikely: This feature request was deemed not to be a good fit for the project. The reason for this is probably stated in the issue conversation. An implementation of this feature is unlikely to be accepted for bundling into an official release. Note: This might still be a useful third-party command in its own right.
    • In case there is no state label associated with the issue, it probably needs more extensive discussion still to find out how it relates to the official WP-CLI code.
Drawing of a software developer working on their laptop.Once you’ve decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it’s a pleasant experience. See “Setting up” for details on making local modifications to WP-CLI. Keep in mind pull requests are expected to have tests covering the scope of the change. Read through our code review guidelines for a better understanding of how your pull request will be evaluated.

Anything missing?

Hopefully, this short guide has presented many different ways of how users and fans of WP-CLI can contribute to the project’s continued success.

If you think we missed anything, please tell us so in the comments below! We’d love to hear your feedback and are curious about yet other ways of contributing to WP-CLI.

(*) Link requires you to be logged into Github, otherwise it will show a 404.
All images provided by unDraw and licensed under the MIT license.