From e73738bf1b924184e31e1f61a249be67526c2148 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Sun, 23 Oct 2016 06:21:49 -0700 Subject: [PATCH 01/17] Blog post draft for v0.25.0 --- _posts/2016-10-25-version-0.25.0.md | 36 +++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 _posts/2016-10-25-version-0.25.0.md diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md new file mode 100644 index 00000000..9e9cb297 --- /dev/null +++ b/_posts/2016-10-25-version-0.25.0.md @@ -0,0 +1,36 @@ +--- +layout: post +author: danielbachhuber +title: Version 0.25.0 released +--- + + +### Everything else in 0.25.0 + +Command improvements: + +* Displays default core language in `wp core version --extra` [[#3221](https://github.com/wp-cli/wp-cli/pull/3221)]. +* Includes adequate vertical spacing around inserted constants [[#3267](https://github.com/wp-cli/wp-cli/pull/3267)]. +* `wp core config`: + * Warns when multisite constants can't be inserted into `wp-config.php`, instead of erroneously inserting at the end [[#3272](https://github.com/wp-cli/wp-cli/pull/3272)]. + * Adds comments to generated `wp-config.php` to better match the one provided by WordPress core [[#3312](https://github.com/wp-cli/wp-cli/pull/3312)]. +* `wp core download`: + * Preserves case for `--version` argument to properly handle release candidates [[#3283](https://github.com/wp-cli/wp-cli/pull/3283)]. +* `wp import`: + * Indicates current file in WXR import progress indicator to communicate the total count is of the current file, not all files [[#3270](https://github.com/wp-cli/wp-cli/pull/3270)]. +* `wp plugin install`: + * Removes branch names from directories created for Github-based ZIPs [[#3314](https://github.com/wp-cli/wp-cli/pull/3314)]. + +Framework enhancements: + +* Updates Composer-based dependencies to latest [[#3257](https://github.com/wp-cli/wp-cli/pull/3257)]. +* Properly handles registering an instantiated object as a command [[#3269](https://github.com/wp-cli/wp-cli/pull/3269)]. + +Bug fixes across the board: + +* Defines all requisite dependencies for PHP 7 on Debian-based systems [[#3208](https://github.com/wp-cli/wp-cli/pull/3208)]. +* Ensures `site --site_id= -> site --network_id=` backwards compat shim only affects `wp site create` [[#3227](https://github.com/wp-cli/wp-cli/pull/3227)]. +* Catches exceptions thrown by `RecursiveDirectoryIterator` when verifying core checksums [[#3266](https://github.com/wp-cli/wp-cli/pull/3266)]. +* Passes slashed data in meta commands [[#3274](https://github.com/wp-cli/wp-cli/pull/3274)]. +* Ensures appropriate WP-CLI package index URL is used in the `composer.json` [[#3276](https://github.com/wp-cli/wp-cli/pull/3276)]. +* Correctly installs parent theme when installing a child theme [[#3301](https://github.com/wp-cli/wp-cli/pull/3301)]. From 6f424ced2da41f13961cda726e2e5b8c9c8700a4 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Sun, 23 Oct 2016 06:27:50 -0700 Subject: [PATCH 02/17] Add some more changelog notes --- _posts/2016-10-25-version-0.25.0.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 9e9cb297..14277115 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -9,17 +9,27 @@ title: Version 0.25.0 released Command improvements: -* Displays default core language in `wp core version --extra` [[#3221](https://github.com/wp-cli/wp-cli/pull/3221)]. -* Includes adequate vertical spacing around inserted constants [[#3267](https://github.com/wp-cli/wp-cli/pull/3267)]. * `wp core config`: - * Warns when multisite constants can't be inserted into `wp-config.php`, instead of erroneously inserting at the end [[#3272](https://github.com/wp-cli/wp-cli/pull/3272)]. * Adds comments to generated `wp-config.php` to better match the one provided by WordPress core [[#3312](https://github.com/wp-cli/wp-cli/pull/3312)]. * `wp core download`: * Preserves case for `--version` argument to properly handle release candidates [[#3283](https://github.com/wp-cli/wp-cli/pull/3283)]. +* `wp core multisite-(install|convert)`: + * Warns when multisite constants can't be inserted into `wp-config.php`, instead of erroneously inserting at the end [[#3272](https://github.com/wp-cli/wp-cli/pull/3272)]. + * Includes adequate vertical spacing around inserted constants [[#3267](https://github.com/wp-cli/wp-cli/pull/3267)]. +* `wp core version`: + * Displays default core language in `wp core version --extra` [[#3221](https://github.com/wp-cli/wp-cli/pull/3221)]. * `wp import`: * Indicates current file in WXR import progress indicator to communicate the total count is of the current file, not all files [[#3270](https://github.com/wp-cli/wp-cli/pull/3270)]. * `wp plugin install`: * Removes branch names from directories created for Github-based ZIPs [[#3314](https://github.com/wp-cli/wp-cli/pull/3314)]. +* `wp search-replace`: + * Ensures tables are quoted to support all permitted characters [[#3318](https://github.com/wp-cli/wp-cli/pull/3318)]. +* `wp server`: + * Supports passing a custom `.ini` file to configure the server [[#3330](https://github.com/wp-cli/wp-cli/pull/3330)]. +* `wp theme install`: + * Correctly installs parent theme when installing a child theme [[#3301](https://github.com/wp-cli/wp-cli/pull/3301)]. +* `wp user create`: + * Prevents email notifications when users are created because email notifications should only be sent when `--send-email` is provided [[#3331](https://github.com/wp-cli/wp-cli/pull/3331)]. Framework enhancements: @@ -33,4 +43,3 @@ Bug fixes across the board: * Catches exceptions thrown by `RecursiveDirectoryIterator` when verifying core checksums [[#3266](https://github.com/wp-cli/wp-cli/pull/3266)]. * Passes slashed data in meta commands [[#3274](https://github.com/wp-cli/wp-cli/pull/3274)]. * Ensures appropriate WP-CLI package index URL is used in the `composer.json` [[#3276](https://github.com/wp-cli/wp-cli/pull/3276)]. -* Correctly installs parent theme when installing a child theme [[#3301](https://github.com/wp-cli/wp-cli/pull/3301)]. From 0cfb272c34f57611e053e4bbcefb4148bc1b3c69 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Sun, 23 Oct 2016 06:48:19 -0700 Subject: [PATCH 03/17] Add compatibility mention --- _posts/2016-10-25-version-0.25.0.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 14277115..45c549db 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -4,6 +4,13 @@ author: danielbachhuber title: Version 0.25.0 released --- +### Compatibility with WordPress 4.7 + +WordPress 4.7 introduces a new `WP_Hook` implementation for registering and executing actions and filters. Because WP-CLI has its own `WP_CLI::add_wp_hook()` that was erroneously accessing the `$wp_filter` global even when `add_filter()` was available, WP-CLI could fatal in certain circumstances. WP-CLI now appropriately calls `add_filter()` when it's available. + +**Importantly, due to the nature of these changes, WP-CLI versions prior to 0.25.0 will be incompatible with WordPress 4.7.** + +Inspect the nature of the change in [this pull request](https://github.com/wp-cli/wp-cli/pull/3384). ### Everything else in 0.25.0 From e030ff59aa4cb562761ab410129ae094effcec96 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Sun, 23 Oct 2016 07:19:58 -0700 Subject: [PATCH 04/17] More changelog additions --- _posts/2016-10-25-version-0.25.0.md | 52 +++++++++++++++++++++++++++-- 1 file changed, 50 insertions(+), 2 deletions(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 45c549db..0eba1adb 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -14,34 +14,81 @@ Inspect the nature of the change in [this pull request](https://github.com/wp-cl ### Everything else in 0.25.0 +New commands: + +* `wp db check` - Runs `mysqlcheck` with the default `--check` option [[#3332](https://github.com/wp-cli/wp-cli/pull/3332)]. +* `wp site option *` - CRUD commands for managing WordPress site options [[#3386](https://github.com/wp-cli/wp-cli/pull/3386)]. +* `wp user session *` - CRUD commands for managing user sessions [[#3307](https://github.com/wp-cli/wp-cli/pull/3307)]. + Command improvements: +* `wp cli update`: + * Introduces `--stable` to install or reinstall the latest stable version [[#3430](https://github.com/wp-cli/wp-cli/pull/3430)]. * `wp core config`: * Adds comments to generated `wp-config.php` to better match the one provided by WordPress core [[#3312](https://github.com/wp-cli/wp-cli/pull/3312)]. * `wp core download`: * Preserves case for `--version` argument to properly handle release candidates [[#3283](https://github.com/wp-cli/wp-cli/pull/3283)]. + * Ensures `wp core download --version=latest` produces correcly-versioned cache key [[#3467](https://github.com/wp-cli/wp-cli/pull/3467)]. +* `wp core language update`: + * Fixes strict standard error about variable reference [[#3380](https://github.com/wp-cli/wp-cli/pull/3380)]. + * Permits updating language packs even when `en_US` is set as locale [[#3397](https://github.com/wp-cli/wp-cli/pull/3397)]. * `wp core multisite-(install|convert)`: * Warns when multisite constants can't be inserted into `wp-config.php`, instead of erroneously inserting at the end [[#3272](https://github.com/wp-cli/wp-cli/pull/3272)]. * Includes adequate vertical spacing around inserted constants [[#3267](https://github.com/wp-cli/wp-cli/pull/3267)]. +* `wp core update-db`: + * Ensures `wp core update-db --network --dry-run` is actually dry [[#3347](https://github.com/wp-cli/wp-cli/pull/3347)]. * `wp core version`: * Displays default core language in `wp core version --extra` [[#3221](https://github.com/wp-cli/wp-cli/pull/3221)]. * `wp import`: * Indicates current file in WXR import progress indicator to communicate the total count is of the current file, not all files [[#3270](https://github.com/wp-cli/wp-cli/pull/3270)]. +* `wp media regenerate`: + * Adds a simple progress indicator [[#3407](https://github.com/wp-cli/wp-cli/pull/3407)]. +* `wp option list`: + * Adds `--no-transients` flag to ignore transients [[#3452](https://github.com/wp-cli/wp-cli/pull/3452)]. + * Adds `--exclude=` argument to list options excluding a specific pattern [[#3455](https://github.com/wp-cli/wp-cli/pull/3455)]. +* `wp package install` + * Displays package dependency details when installing a package with a dependency [[#3418](https://github.com/wp-cli/wp-cli/pull/3418), [#3425](https://github.com/wp-cli/wp-cli/pull/3425)]. +* `wp package uninstall` + * Removes a package's dependencies when the package is removed [[#3343](https://github.com/wp-cli/wp-cli/pull/3343)]. + * Properly assigns `$composer_backup` when uninstalling [[#3399](https://github.com/wp-cli/wp-cli/pull/3399)]. * `wp plugin install`: - * Removes branch names from directories created for Github-based ZIPs [[#3314](https://github.com/wp-cli/wp-cli/pull/3314)]. + * Removes branch names from directories created for Github-based ZIPs [[#3314](https://github.com/wp-cli/wp-cli/pull/3314), [#3451](https://github.com/wp-cli/wp-cli/pull/3451)]. +* `wp scaffold plugin-tests`: + * Uses PHP version specific to Trusty on CircleCI [[#3359](https://github.com/wp-cli/wp-cli/pull/3359)]. + * Uses correct default user for MySQL on CircleCI [[#3457](https://github.com/wp-cli/wp-cli/pull/3457)]. + * Uses the latest version of PHPUnit on Travis, depending on PHP version [[#3463](https://github.com/wp-cli/wp-cli/pull/3463)]. + * Adds WordPress Coding Standards to newly-scaffolded plugins [[#3472](https://github.com/wp-cli/wp-cli/pull/3472)]. * `wp search-replace`: * Ensures tables are quoted to support all permitted characters [[#3318](https://github.com/wp-cli/wp-cli/pull/3318)]. + * Prevents error notice when `export_insert_size` isn't defined [[#3357](https://github.com/wp-cli/wp-cli/pull/3357)]. + * Fails back to PHP if SQL triggers an error for some reason [[#3387](https://github.com/wp-cli/wp-cli/pull/3387)]. * `wp server`: * Supports passing a custom `.ini` file to configure the server [[#3330](https://github.com/wp-cli/wp-cli/pull/3330)]. +* `wp site create`: + * Use `get_blog_details()` for the site URL when creating a new site to ensure the correct URL is displayed [[#3416](https://github.com/wp-cli/wp-cli/pull/3416)]. +* `wp site empty`: + * Ensures the entire uploads directory is empty [[#3400](https://github.com/wp-cli/wp-cli/pull/3400)]. * `wp theme install`: * Correctly installs parent theme when installing a child theme [[#3301](https://github.com/wp-cli/wp-cli/pull/3301)]. +* `wp transient`: + * Consolidates `wp transient delete-all` and `wp transient delete-expired` to flags of `wp transient delete` [[#3389](https://github.com/wp-cli/wp-cli/pull/3389)]. * `wp user create`: * Prevents email notifications when users are created because email notifications should only be sent when `--send-email` is provided [[#3331](https://github.com/wp-cli/wp-cli/pull/3331)]. Framework enhancements: -* Updates Composer-based dependencies to latest [[#3257](https://github.com/wp-cli/wp-cli/pull/3257)]. +* Updates Composer-based dependencies to latest [[#3257](https://github.com/wp-cli/wp-cli/pull/3257), [#3429](https://github.com/wp-cli/wp-cli/pull/3429), [#3460](https://github.com/wp-cli/wp-cli/pull/3460), [#3468](https://github.com/wp-cli/wp-cli/pull/3468)]. * Properly handles registering an instantiated object as a command [[#3269](https://github.com/wp-cli/wp-cli/pull/3269)]. +* Splits the `ProcessRun` class out to its own file [[#3377](https://github.com/wp-cli/wp-cli/pull/3377), [#3422](https://github.com/wp-cli/wp-cli/pull/3422)]. +* Permits running test suite with `WP_VERSION` env variable [[#3383](https://github.com/wp-cli/wp-cli/pull/3383), [#3392](https://github.com/wp-cli/wp-cli/pull/3392)]. +* Prevents error notice when using `Utils\get_named_sem_ver()` with WP versions [[#3404](https://github.com/wp-cli/wp-cli/pull/3404)]. +* Fixes fatal error for failed early database connection by handling `dead_db()` error on `nocache_headers` filter [[#3440](https://github.com/wp-cli/wp-cli/pull/3440)]. +* Assigns a default `$_SERVER['SERVER_NAME']` to prevent uncaught exception when `wp_mail()` is used [[#3449](https://github.com/wp-cli/wp-cli/pull/3449)]. +* Ignores `url:` in `wp-cli.yml` when alias is used, because aliases completely override user, url, path, ssh, and http [[#3450](https://github.com/wp-cli/wp-cli/pull/3450)]. +* Warns when `WP_CLI::launch()` ends up with `return_code=-1`, which could be caused by a custom compiled version of PHP that uses the `--enable-sigchild` option [[#3458](https://github.com/wp-cli/wp-cli/pull/3458)]. +* Provides more verbosity in `wp_die()` handler to give the end user more detail when a database connection fails [[#3459](https://github.com/wp-cli/wp-cli/pull/3459)]. +* Support passing arguments to `WP_CLI::do_hook()` [[#3470](https://github.com/wp-cli/wp-cli/pull/3470)]. +* Logs the current alias when executing an alias group [[#3471](https://github.com/wp-cli/wp-cli/pull/3471)]. Bug fixes across the board: @@ -50,3 +97,4 @@ Bug fixes across the board: * Catches exceptions thrown by `RecursiveDirectoryIterator` when verifying core checksums [[#3266](https://github.com/wp-cli/wp-cli/pull/3266)]. * Passes slashed data in meta commands [[#3274](https://github.com/wp-cli/wp-cli/pull/3274)]. * Ensures appropriate WP-CLI package index URL is used in the `composer.json` [[#3276](https://github.com/wp-cli/wp-cli/pull/3276)]. +* Corrects reference of `WP_CLI` to use global namespace in `WP_CLI\Utils\get_temp_dir()` [[#3369](https://github.com/wp-cli/wp-cli/pull/3369)]. From bbc24a51cd81add63892156472f601e1b80240cb Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Sun, 23 Oct 2016 07:33:47 -0700 Subject: [PATCH 05/17] Add section on installing packages --- _posts/2016-10-25-version-0.25.0.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 0eba1adb..2790dcda 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -12,6 +12,20 @@ WordPress 4.7 introduces a new `WP_Hook` implementation for registering and exec Inspect the nature of the change in [this pull request](https://github.com/wp-cli/wp-cli/pull/3384). +### More ways to install WP-CLI packages + +Although we'd love to see your package listed in the package index, we realize there are reasons you might not be able to do so. `wp package install` now supports installing an arbitrary Git URL [[#3482](https://github.com/wp-cli/wp-cli/pull/3482)], `.zip` file [[#3485](https://github.com/wp-cli/wp-cli/pull/3485)], or directory path [[#3484](https://github.com/wp-cli/wp-cli/pull/3484)] as a package. + + $ wp package install git@github.com:wp-cli/google-sitemap-generator-cli.git + $ wp package install https://github.com/wp-cli/google-sitemap-generator.zip + $ wp package install google-sitemap-generator + +It's worth noting Composer's behavior is slightly different for each package type: + +* Git URLs are treated as VCS repositories, and cloned to `~/.wp-cli/packages/vendor`. +* ZIP archives (remote and local) are extracted to `~/.wp-cli/packages/local`, and added as path repositories. +* Local directory paths are added as path repositories, which means Composer creates a symlink to the existing directory path. If the directory you've provided is removed, then the installation will break. + ### Everything else in 0.25.0 New commands: @@ -89,6 +103,7 @@ Framework enhancements: * Provides more verbosity in `wp_die()` handler to give the end user more detail when a database connection fails [[#3459](https://github.com/wp-cli/wp-cli/pull/3459)]. * Support passing arguments to `WP_CLI::do_hook()` [[#3470](https://github.com/wp-cli/wp-cli/pull/3470)]. * Logs the current alias when executing an alias group [[#3471](https://github.com/wp-cli/wp-cli/pull/3471)]. +* Only checks `options` for a positional argument when a value is present [[#3481](https://github.com/wp-cli/wp-cli/pull/3481)]. Bug fixes across the board: @@ -98,3 +113,7 @@ Bug fixes across the board: * Passes slashed data in meta commands [[#3274](https://github.com/wp-cli/wp-cli/pull/3274)]. * Ensures appropriate WP-CLI package index URL is used in the `composer.json` [[#3276](https://github.com/wp-cli/wp-cli/pull/3276)]. * Corrects reference of `WP_CLI` to use global namespace in `WP_CLI\Utils\get_temp_dir()` [[#3369](https://github.com/wp-cli/wp-cli/pull/3369)]. + +Contributors to this release: + +You can browse the full list of [resolved issues](https://github.com/wp-cli/wp-cli/issues?q=milestone%3A0.25.0+is%3Aclosed) on Github. From 1cba89ffbffb16fe39f037b7c60d32a339f0e558 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 05:02:21 -0700 Subject: [PATCH 06/17] Update latest WP-CLI version --- de/index.md | 2 +- fr/index.md | 2 +- gr/index.md | 2 +- index.md | 2 +- it/index.md | 2 +- ja/index.md | 2 +- tr/index.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/de/index.md b/de/index.md index e0d9ed2e..ab63dbe0 100644 --- a/de/index.md +++ b/de/index.md @@ -77,7 +77,7 @@ 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: 0.23.0 +WP-CLI version: 0.25.0 ``` ### Aktualisieren diff --git a/fr/index.md b/fr/index.md index 6ce95e11..669fd8ad 100644 --- a/fr/index.md +++ b/fr/index.md @@ -77,7 +77,7 @@ 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: 0.24.1 +WP-CLI version: 0.25.0 ``` ### Mise à jour diff --git a/gr/index.md b/gr/index.md index 4e1aab4c..3c74866f 100644 --- a/gr/index.md +++ b/gr/index.md @@ -77,7 +77,7 @@ 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: 0.24.1 +WP-CLI version: 0.25.0 ``` ### Ενημέρωση diff --git a/index.md b/index.md index bfacc4c0..bdfc4dac 100644 --- a/index.md +++ b/index.md @@ -77,7 +77,7 @@ 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: 0.24.1 +WP-CLI version: 0.25.0 ``` ### Updating diff --git a/it/index.md b/it/index.md index f0abec9b..44467ede 100644 --- a/it/index.md +++ b/it/index.md @@ -88,7 +88,7 @@ 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: 0.23.0 +WP-CLI version: 0.25.0 ``` ### Aggiornamenti diff --git a/ja/index.md b/ja/index.md index c8a48306..73b22452 100644 --- a/ja/index.md +++ b/ja/index.md @@ -79,7 +79,7 @@ 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: 0.24.1 +WP-CLI version: 0.25.0 ``` ## アップデート diff --git a/tr/index.md b/tr/index.md index 04dede3d..ab2a24ce 100644 --- a/tr/index.md +++ b/tr/index.md @@ -85,7 +85,7 @@ 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: 0.24.1 +WP-CLI version: 0.25.0 ``` From 3e21f03a6eb0f416d9dd6fc4a3e9fda027d55da9 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 05:11:34 -0700 Subject: [PATCH 07/17] Mention bash completion improvements --- _posts/2016-10-25-version-0.25.0.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 2790dcda..c7632dd0 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -104,6 +104,7 @@ Framework enhancements: * Support passing arguments to `WP_CLI::do_hook()` [[#3470](https://github.com/wp-cli/wp-cli/pull/3470)]. * Logs the current alias when executing an alias group [[#3471](https://github.com/wp-cli/wp-cli/pull/3471)]. * Only checks `options` for a positional argument when a value is present [[#3481](https://github.com/wp-cli/wp-cli/pull/3481)]. +* Variety of bash completion improvements [[#3490](https://github.com/wp-cli/wp-cli/pull/3490), [#3491](https://github.com/wp-cli/wp-cli/pull/3491), [#3492](https://github.com/wp-cli/wp-cli/pull/3492)]. Bug fixes across the board: From 2db939adf294374a1398f7d286585bc90000b3a6 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 05:27:34 -0700 Subject: [PATCH 08/17] Update contributor list --- _posts/2016-10-25-version-0.25.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index c7632dd0..5b1552a6 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -115,6 +115,6 @@ Bug fixes across the board: * Ensures appropriate WP-CLI package index URL is used in the `composer.json` [[#3276](https://github.com/wp-cli/wp-cli/pull/3276)]. * Corrects reference of `WP_CLI` to use global namespace in `WP_CLI\Utils\get_temp_dir()` [[#3369](https://github.com/wp-cli/wp-cli/pull/3369)]. -Contributors to this release: +Contributors to this release (pull requests, documentation, and package authors): [2ndkauboy](https://github.com/2ndkauboy), [aaemnnosttv](https://github.com/aaemnnosttv), [balbuf](https://github.com/balbuf), [bradp](https://github.com/bradp), [danielbachhuber](https://github.com/danielbachhuber), [ernilambar](https://github.com/ernilambar), [fisele](https://github.com/fisele), [johnbillion](https://github.com/johnbillion), [jorgeatorres](https://github.com/jorgeatorres), [iandunn](https://github.com/iandunn), [miya0001](https://github.com/miya0001), [nyordanov](https://github.com/nyordanov), [ocean90](https://github.com/ocean90), [rahulsprajapati](https://github.com/rahulsprajapati), [shulard](https://github.com/shulard), [szepeviktor](https://github.com/szepeviktor), [tnorthcutt](https://github.com/tnorthcutt), [veganista](https://github.com/veganista) You can browse the full list of [resolved issues](https://github.com/wp-cli/wp-cli/issues?q=milestone%3A0.25.0+is%3Aclosed) on Github. From 76c73ee2822029fa9366676c2b5f63c6d2ddf1c1 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 05:53:56 -0700 Subject: [PATCH 09/17] List all of the new packages --- _posts/2016-10-25-version-0.25.0.md | 33 ++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 5b1552a6..2d6c9482 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -6,15 +6,42 @@ title: Version 0.25.0 released ### Compatibility with WordPress 4.7 -WordPress 4.7 introduces a new `WP_Hook` implementation for registering and executing actions and filters. Because WP-CLI has its own `WP_CLI::add_wp_hook()` that was erroneously accessing the `$wp_filter` global even when `add_filter()` was available, WP-CLI could fatal in certain circumstances. WP-CLI now appropriately calls `add_filter()` when it's available. +WordPress 4.7 introduces a new `WP_Hook` implementation for registering and executing actions and filters. Because WP-CLI has its own `WP_CLI::add_wp_hook()` that was erroneously accessing the `$wp_filter` global even when the `add_filter()` function was available, WP-CLI could fatal in certain circumstances. WP-CLI now appropriately calls `add_filter()` when it's available. **Importantly, due to the nature of these changes, WP-CLI versions prior to 0.25.0 will be incompatible with WordPress 4.7.** -Inspect the nature of the change in [this pull request](https://github.com/wp-cli/wp-cli/pull/3384). +Inspect the change in [this pull request](https://github.com/wp-cli/wp-cli/pull/3384). + +### New packages in the Package Index + +The WP-CLI community has been quite active in creating new tools for you to use (and contribute back to): + +* [aaemnnosttv/wp-cli-login-command](https://github.com/aaemnnosttv/wp-cli-login-command) - Login to WordPress with secure passwordless magic links. +* [alessandrotesoro/wp-cli-helpscout-docs-parser](https://github.com/alessandrotesoro/wp-cli-helpscout-docs-parser) - Extract helpscout docs articles and categories to build an offline documentation. +* [alessandrotesoro/wp-usergen-cli](https://github.com/alessandrotesoro/wp-usergen-cli) - Generate random users for testing purposes. +* [anhskohbo/wp-cli-themecheck](https://github.com/anhskohbo/wp-cli-themecheck) - Run Themecheck in WP-CLI. +* [BeAPI/wp-cli-light-db-export](https://github.com/BeAPI/wp-cli-light-db-export) - Allows you to export big databases with all the tables but not all the data. +* [binarygary/db-checkpoint](https://github.com/binarygary/db-checkpoint) - Treat your DB like a save point in a video game. +* [brightoak/wp-cli-envoyer](https://github.com/brightoak/wp-cli-envoyer) - Invoke an Envoyer deployment via WP-CLI. +* [getshifter/wp-cli-shifter](https://github.com/getshifter/wp-cli-shifter) - Enables you to import/export your WordPress site for the Shifter. +* [eriktorsner/wp-checksum](https://github.com/eriktorsner/wp-checksum) - Verify checksums for themes and plugins. +* [iandunn/wp-cli-plugin-active-on-sites](https://github.com/iandunn/wp-cli-plugin-active-on-sites) - List all sites in a multisite network that have activated a given plugin. +* [markri/wp-sec](https://github.com/markri/wp-sec) - Checks for WordPress CVE security issues at wpvulndb.com. +* [mattgrshaw/wp-installer](https://github.com/mattgrshaw/wp-installer) - Simple commands to install and uninstall WordPress. +* [pressbooks/pb-cli](https://github.com/pressbooks/pb-cli) - A suite of wp-cli commands for Pressbooks. +* [runcommand/assign-featured-images](https://github.com/runcommand/assign-featured-images) - Assign featured images to posts that support thumbnails. +* [runcommand/manifest](https://github.com/runcommand/manifest) - Produces an overview of WordPress' configuration for a high-level understanding of what's going on inside of WordPress. +* [rxnlabs/wp-composer](https://github.com/rxnlabs/wp-composer) - Manage your WordPress site dependencies using the power of Composer. +* [trendwerk/faker](https://github.com/trendwerk/faker) - Fake post data with WP-CLI. +* [trepmal/blog-extractor](https://github.com/trepmal/blog-extractor) - Extract a single blog from multisite. +* [trepmal/wp-revisions-cli](https://github.com/trepmal/wp-revisions-cli) - Manage revisions. +* [welaika/wp-cli-db2utf8](https://github.com/welaika/wp-cli-db2utf8) - Downgrade db encoding of a new WP installation to UTF8. + +Install any one of these with `wp package install `. When you do, go say thanks to the author! ### More ways to install WP-CLI packages -Although we'd love to see your package listed in the package index, we realize there are reasons you might not be able to do so. `wp package install` now supports installing an arbitrary Git URL [[#3482](https://github.com/wp-cli/wp-cli/pull/3482)], `.zip` file [[#3485](https://github.com/wp-cli/wp-cli/pull/3485)], or directory path [[#3484](https://github.com/wp-cli/wp-cli/pull/3484)] as a package. +Although we'd love to see your package listed in the Package Index, we realize there are reasons you might not be able to do so. `wp package install` now supports installing an arbitrary Git URL [[#3482](https://github.com/wp-cli/wp-cli/pull/3482)], `.zip` file [[#3485](https://github.com/wp-cli/wp-cli/pull/3485)], or directory path [[#3484](https://github.com/wp-cli/wp-cli/pull/3484)] as a package. $ wp package install git@github.com:wp-cli/google-sitemap-generator-cli.git $ wp package install https://github.com/wp-cli/google-sitemap-generator.zip From e20efb685b1922608d3917d32478dcee30048a62 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 06:01:27 -0700 Subject: [PATCH 10/17] Update contributor list from package authors --- _posts/2016-10-25-version-0.25.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 2d6c9482..11174e68 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -142,6 +142,6 @@ Bug fixes across the board: * Ensures appropriate WP-CLI package index URL is used in the `composer.json` [[#3276](https://github.com/wp-cli/wp-cli/pull/3276)]. * Corrects reference of `WP_CLI` to use global namespace in `WP_CLI\Utils\get_temp_dir()` [[#3369](https://github.com/wp-cli/wp-cli/pull/3369)]. -Contributors to this release (pull requests, documentation, and package authors): [2ndkauboy](https://github.com/2ndkauboy), [aaemnnosttv](https://github.com/aaemnnosttv), [balbuf](https://github.com/balbuf), [bradp](https://github.com/bradp), [danielbachhuber](https://github.com/danielbachhuber), [ernilambar](https://github.com/ernilambar), [fisele](https://github.com/fisele), [johnbillion](https://github.com/johnbillion), [jorgeatorres](https://github.com/jorgeatorres), [iandunn](https://github.com/iandunn), [miya0001](https://github.com/miya0001), [nyordanov](https://github.com/nyordanov), [ocean90](https://github.com/ocean90), [rahulsprajapati](https://github.com/rahulsprajapati), [shulard](https://github.com/shulard), [szepeviktor](https://github.com/szepeviktor), [tnorthcutt](https://github.com/tnorthcutt), [veganista](https://github.com/veganista) +Contributors to this release (pull requests, documentation, and package authors): [2ndkauboy](https://github.com/2ndkauboy), [aaemnnosttv](https://github.com/aaemnnosttv), [alessandrotesoro](https://github.com/alessandrotesoro), [anhskohbo](https://github.com/anhskohbo), [balbuf](https://github.com/balbuf), [BeAPI](https://github.com/BeAPI), [binarygary](https://github.com/binarygary), [bradp](https://github.com/bradp), [brightoak](https://github.com/brightoak), [danielbachhuber](https://github.com/danielbachhuber), [getshifter](https://github.com/getshifter), [eriktorsner](https://github.com/eriktorsner), [ernilambar](https://github.com/ernilambar), [fisele](https://github.com/fisele), [johnbillion](https://github.com/johnbillion), [jorgeatorres](https://github.com/jorgeatorres), [iandunn](https://github.com/iandunn), [markri](https://github.com/markri), [mattgrshaw](https://github.com/mattgrshaw), [miya0001](https://github.com/miya0001), [nyordanov](https://github.com/nyordanov), [ocean90](https://github.com/ocean90), [pressbooks](https://github.com/pressbooks), [rahulsprajapati](https://github.com/rahulsprajapati), [runcommand](https://github.com/runcommand), [rxnlabs](https://github.com/rxnlabs), [shulard](https://github.com/shulard), [szepeviktor](https://github.com/szepeviktor), [tnorthcutt](https://github.com/tnorthcutt), [trendwerk](https://github.com/trendwerk), [trepmal](https://github.com/trepmal), [veganista](https://github.com/veganista), [welaika](https://github.com/welaika) You can browse the full list of [resolved issues](https://github.com/wp-cli/wp-cli/issues?q=milestone%3A0.25.0+is%3Aclosed) on Github. From fe7cacb37da4b81b6c8b04ff8566db9e1ea69fea Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 06:07:25 -0700 Subject: [PATCH 11/17] Update contributors for docs contributors --- _posts/2016-10-25-version-0.25.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 11174e68..904bc9db 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -142,6 +142,6 @@ Bug fixes across the board: * Ensures appropriate WP-CLI package index URL is used in the `composer.json` [[#3276](https://github.com/wp-cli/wp-cli/pull/3276)]. * Corrects reference of `WP_CLI` to use global namespace in `WP_CLI\Utils\get_temp_dir()` [[#3369](https://github.com/wp-cli/wp-cli/pull/3369)]. -Contributors to this release (pull requests, documentation, and package authors): [2ndkauboy](https://github.com/2ndkauboy), [aaemnnosttv](https://github.com/aaemnnosttv), [alessandrotesoro](https://github.com/alessandrotesoro), [anhskohbo](https://github.com/anhskohbo), [balbuf](https://github.com/balbuf), [BeAPI](https://github.com/BeAPI), [binarygary](https://github.com/binarygary), [bradp](https://github.com/bradp), [brightoak](https://github.com/brightoak), [danielbachhuber](https://github.com/danielbachhuber), [getshifter](https://github.com/getshifter), [eriktorsner](https://github.com/eriktorsner), [ernilambar](https://github.com/ernilambar), [fisele](https://github.com/fisele), [johnbillion](https://github.com/johnbillion), [jorgeatorres](https://github.com/jorgeatorres), [iandunn](https://github.com/iandunn), [markri](https://github.com/markri), [mattgrshaw](https://github.com/mattgrshaw), [miya0001](https://github.com/miya0001), [nyordanov](https://github.com/nyordanov), [ocean90](https://github.com/ocean90), [pressbooks](https://github.com/pressbooks), [rahulsprajapati](https://github.com/rahulsprajapati), [runcommand](https://github.com/runcommand), [rxnlabs](https://github.com/rxnlabs), [shulard](https://github.com/shulard), [szepeviktor](https://github.com/szepeviktor), [tnorthcutt](https://github.com/tnorthcutt), [trendwerk](https://github.com/trendwerk), [trepmal](https://github.com/trepmal), [veganista](https://github.com/veganista), [welaika](https://github.com/welaika) +Contributors to this release (pull requests, documentation, and package authors): [2ndkauboy](https://github.com/2ndkauboy), [aaemnnosttv](https://github.com/aaemnnosttv), [alessandrotesoro](https://github.com/alessandrotesoro), [anhskohbo](https://github.com/anhskohbo), [balbuf](https://github.com/balbuf), [BeAPI](https://github.com/BeAPI), [binarygary](https://github.com/binarygary), [bradp](https://github.com/bradp), [brightoak](https://github.com/brightoak), [danielbachhuber](https://github.com/danielbachhuber), [danilomaccioni](https://github.com/danilomaccioni), [diggy](https://github.com/diggy), [getshifter](https://github.com/getshifter), [eriktorsner](https://github.com/eriktorsner), [ernilambar](https://github.com/ernilambar), [fisele](https://github.com/fisele), [grappler](https://github.com/grappler), [guillaumemolter](https://github.com/guillaumemolter), [iandunn](https://github.com/iandunn), [johnbillion](https://github.com/johnbillion), [jorgeatorres](https://github.com/jorgeatorres), [kouratoras](https://github.com/kouratoras), [markri](https://github.com/markri), [mattgrshaw](https://github.com/mattgrshaw), [miya0001](https://github.com/miya0001), [mustafauysal](https://github.com/mustafauysal), [nyordanov](https://github.com/nyordanov), [ocean90](https://github.com/ocean90), [petenelson](https://github.com/petenelson), [polevaultweb](https://github.com/polevaultweb), [pressbooks](https://github.com/pressbooks), [rahulsprajapati](https://github.com/rahulsprajapati), [runcommand](https://github.com/runcommand), [rxnlabs](https://github.com/rxnlabs), [shulard](https://github.com/shulard), [swissspidy](https://github.com/swissspidy), [szepeviktor](https://github.com/szepeviktor), [taianunes](https://github.com/taianunes), [tnorthcutt](https://github.com/tnorthcutt), [trendwerk](https://github.com/trendwerk), [trepmal](https://github.com/trepmal), [veganista](https://github.com/veganista), [welaika](https://github.com/welaika) You can browse the full list of [resolved issues](https://github.com/wp-cli/wp-cli/issues?q=milestone%3A0.25.0+is%3Aclosed) on Github. From 08c3de7219e9713d500d5a9711185e0132d4cf1f Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 11:48:26 -0700 Subject: [PATCH 12/17] Mention the roadmap --- _posts/2016-10-25-version-0.25.0.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 904bc9db..7663aaf0 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -4,6 +4,10 @@ author: danielbachhuber title: Version 0.25.0 released --- +Happy release day! Today, I'm excited to bring you WP-CLI v0.25.0. Check out the [newly published roadmap](/docs/roadmap/) for details on upcoming releases and product focus (hint: there's a future where WP-CLI no longer supports PHP 5.3). + +Let's dive in. + ### Compatibility with WordPress 4.7 WordPress 4.7 introduces a new `WP_Hook` implementation for registering and executing actions and filters. Because WP-CLI has its own `WP_CLI::add_wp_hook()` that was erroneously accessing the `$wp_filter` global even when the `add_filter()` function was available, WP-CLI could fatal in certain circumstances. WP-CLI now appropriately calls `add_filter()` when it's available. @@ -43,9 +47,11 @@ Install any one of these with `wp package install `. When you do, Although we'd love to see your package listed in the Package Index, we realize there are reasons you might not be able to do so. `wp package install` now supports installing an arbitrary Git URL [[#3482](https://github.com/wp-cli/wp-cli/pull/3482)], `.zip` file [[#3485](https://github.com/wp-cli/wp-cli/pull/3485)], or directory path [[#3484](https://github.com/wp-cli/wp-cli/pull/3484)] as a package. - $ wp package install git@github.com:wp-cli/google-sitemap-generator-cli.git - $ wp package install https://github.com/wp-cli/google-sitemap-generator.zip - $ wp package install google-sitemap-generator + $ wp package install git@github.com:runcommand/doctor.git + $ wp package install https://github.com/runcommand/doctor.zip + $ wp package install doctor + +(doctor is the [second premium WP-CLI command from runcommand](https://runcommand.io/wp/doctor/)) It's worth noting Composer's behavior is slightly different for each package type: From 24fbf3bcc1eeee79e857594292aa65e25c4dbf48 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 12:01:18 -0700 Subject: [PATCH 13/17] Rebuild docs for v0.25.0 --- commands/cli/alias/index.md | 16 +++++- commands/cli/check-update/index.md | 12 ++-- commands/cli/cmd-dump/index.md | 2 +- commands/cli/index.md | 16 +++--- commands/cli/info/index.md | 3 +- commands/cli/param-dump/index.md | 1 + commands/cli/update/index.md | 32 ++++++++--- commands/cli/version/index.md | 3 +- commands/comment/approve/index.md | 3 +- commands/comment/count/index.md | 4 +- commands/comment/create/index.md | 1 + commands/comment/delete/index.md | 4 +- commands/comment/exists/index.md | 1 + commands/comment/generate/index.md | 13 ++++- commands/comment/get/index.md | 1 + commands/comment/index.md | 8 +-- commands/comment/list/index.md | 6 +- commands/comment/meta/add/index.md | 8 ++- commands/comment/meta/update/index.md | 8 ++- commands/comment/recount/index.md | 1 + commands/comment/spam/index.md | 1 + commands/comment/status/index.md | 1 + commands/comment/trash/index.md | 1 + commands/comment/unapprove/index.md | 3 +- commands/comment/unspam/index.md | 1 + commands/comment/untrash/index.md | 1 + commands/comment/update/index.md | 1 + commands/comment/url/index.md | 3 +- commands/core/install/index.md | 4 ++ commands/core/language/activate/index.md | 5 ++ commands/core/language/install/index.md | 5 ++ commands/core/language/list/index.md | 10 ++++ commands/core/language/uninstall/index.md | 5 ++ commands/core/language/update/index.md | 11 ++++ commands/core/version/index.md | 1 + commands/db/check/index.md | 28 ++++++++++ commands/db/import/index.md | 6 ++ commands/db/index.md | 4 ++ commands/db/optimize/index.md | 2 +- commands/db/query/index.md | 9 +++ commands/db/repair/index.md | 2 +- commands/db/tables/index.md | 8 ++- commands/eval/index.md | 10 ++++ commands/media/import/index.md | 34 ++++++------ commands/media/index.md | 12 ++-- commands/media/regenerate/index.md | 28 ++++++---- commands/menu/delete/index.md | 2 +- commands/menu/item/delete/index.md | 2 +- commands/menu/item/index.md | 2 +- commands/network/meta/add/index.md | 8 ++- commands/network/meta/update/index.md | 8 ++- commands/option/add/index.md | 5 +- commands/option/list/index.md | 10 +++- commands/option/update/index.md | 5 +- commands/package/browse/index.md | 3 + commands/package/index.md | 2 +- commands/package/install/index.md | 33 +++++++++-- commands/package/list/index.md | 3 + commands/plugin/install/index.md | 9 +++ commands/plugin/list/index.md | 29 +++++----- commands/post/generate/index.md | 8 +-- commands/post/list/index.md | 2 +- commands/post/meta/add/index.md | 8 ++- commands/post/meta/update/index.md | 8 ++- commands/role/create/index.md | 8 +-- commands/role/delete/index.md | 8 +-- commands/role/exists/index.md | 5 +- commands/role/index.md | 18 +++--- commands/role/list/index.md | 1 + commands/role/reset/index.md | 4 +- commands/scaffold/plugin-tests/index.md | 2 +- commands/scaffold/plugin/index.md | 12 +++- commands/server/index.md | 10 ++++ commands/site/create/index.md | 2 +- commands/site/index.md | 4 ++ commands/site/option/add/index.md | 39 +++++++++++++ commands/site/option/delete/index.md | 26 +++++++++ commands/site/option/get/index.md | 37 ++++++++++++ commands/site/option/index.md | 68 +++++++++++++++++++++++ commands/site/option/list/index.md | 63 +++++++++++++++++++++ commands/site/option/update/index.md | 39 +++++++++++++ commands/taxonomy/get/index.md | 45 +++++---------- commands/taxonomy/index.md | 6 +- commands/taxonomy/list/index.md | 6 +- commands/term/generate/index.md | 16 ++++-- commands/term/meta/add/index.md | 8 ++- commands/term/meta/update/index.md | 8 ++- commands/theme/get/index.md | 10 +++- commands/theme/list/index.md | 11 +++- commands/theme/search/index.md | 11 +++- commands/transient/delete/index.md | 17 +++++- commands/transient/index.md | 22 +++----- commands/user/generate/index.md | 17 ++++-- commands/user/get/index.md | 10 +++- commands/user/index.md | 4 ++ commands/user/list/index.md | 12 +++- commands/user/meta/get/index.md | 10 +++- commands/user/meta/list/index.md | 15 ++++- commands/user/session/destroy/index.md | 46 +++++++++++++++ commands/user/session/index.md | 40 +++++++++++++ commands/user/session/list/index.md | 59 ++++++++++++++++++++ commands/widget/deactivate/index.md | 2 +- commands/widget/delete/index.md | 2 +- commands/widget/index.md | 2 +- 104 files changed, 991 insertions(+), 220 deletions(-) create mode 100644 commands/db/check/index.md create mode 100644 commands/site/option/add/index.md create mode 100644 commands/site/option/delete/index.md create mode 100644 commands/site/option/get/index.md create mode 100644 commands/site/option/index.md create mode 100644 commands/site/option/list/index.md create mode 100644 commands/site/option/update/index.md create mode 100644 commands/user/session/destroy/index.md create mode 100644 commands/user/session/index.md create mode 100644 commands/user/session/list/index.md diff --git a/commands/cli/alias/index.md b/commands/cli/alias/index.md index 99e5b488..f570aaa8 100644 --- a/commands/cli/alias/index.md +++ b/commands/cli/alias/index.md @@ -13,7 +13,7 @@ display_global_parameters: true
Aliases are shorthand references to WordPress installs. For instance, -'@dev' could refer to a development install and '@prod' could refer to +`@dev` could refer to a development install and `@prod` could refer to a production install. This command gives you visibility in what registered aliases you have available. @@ -28,5 +28,19 @@ options: - json \--- +### EXAMPLES + + # List all available aliases. + $ wp cli alias + --- + @all: Run command against every registered alias. + @prod: + ssh: runcommand@runcommand.io~/webapps/production + @dev: + ssh: vagrant@192.168.50.10/srv/www/runcommand.dev + @both: + - @prod + - @dev + diff --git a/commands/cli/check-update/index.md b/commands/cli/check-update/index.md index 0bd7b4be..bf64914c 100644 --- a/commands/cli/check-update/index.md +++ b/commands/cli/check-update/index.md @@ -15,13 +15,13 @@ display_global_parameters: true ### OPTIONS [\--patch] -: Only list patch updates +: Only list patch updates. [\--minor] -: Only list minor updates +: Only list minor updates. [\--major] -: Only list major updates +: Only list major updates. [\--field=<field>] : Prints the value of a single field for each update. @@ -43,16 +43,16 @@ options: ### EXAMPLES - # Check for update + # Check for update. $ wp cli check-update Success: WP-CLI is at the latest version. - # Check for update and new version is available + # Check for update and new version is available. $ wp cli check-update +---------+-------------+-------------------------------------------------------------------------------+ | version | update_type | package_url | +---------+-------------+-------------------------------------------------------------------------------+ - | 0.23.1 | patch | https://github.com/wp-cli/wp-cli/releases/download/v0.23.1/wp-cli-0.23.1.phar | + | 0.24.1 | patch | https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar | +---------+-------------+-------------------------------------------------------------------------------+ diff --git a/commands/cli/cmd-dump/index.md b/commands/cli/cmd-dump/index.md index 943ab8a9..66492521 100644 --- a/commands/cli/cmd-dump/index.md +++ b/commands/cli/cmd-dump/index.md @@ -14,7 +14,7 @@ display_global_parameters: true ### EXAMPLES - # Dump the list of installed commands + # Dump the list of installed commands. $ wp cli cmd-dump {"name":"wp","description":"Manage WordPress through the command-line.","longdesc":"\n\n diff --git a/commands/cli/index.md b/commands/cli/index.md index e2f3c78d..21eecf74 100644 --- a/commands/cli/index.md +++ b/commands/cli/index.md @@ -14,20 +14,20 @@ display_global_parameters: true ### EXAMPLES - # Display CLI version + # Display CLI version. $ wp cli version - WP-CLI 0.23.1 + WP-CLI 0.24.1 - # Check for update + # Check for update. $ wp cli check-update Success: WP-CLI is at the latest version. - # Update CLI + # Update CLI. $ wp cli update - You have version 0.23.0. Would you like to update to 0.23.1? [y/n] y - Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.23.1/wp-cli-0.23.1.phar... + You have version 0.24.0. Would you like to update to 0.24.1? [y/n] y + Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar... New version works. Proceeding to replace. - Success: Updated WP-CLI to 0.23.1 + Success: Updated WP-CLI to 0.24.1. @@ -67,7 +67,7 @@ display_global_parameters: true update - Fetch most recent update matching the requirements. Returns the available versions if there are updates, or empty if no update available. + Update WP-CLI. version diff --git a/commands/cli/info/index.md b/commands/cli/info/index.md index f9ca2d93..0e53393e 100644 --- a/commands/cli/info/index.md +++ b/commands/cli/info/index.md @@ -25,6 +25,7 @@ options: ### EXAMPLES + # Display various data about the CLI environment. $ wp cli info PHP binary: /usr/bin/php5 PHP version: 5.5.9-1ubuntu4.16 @@ -33,7 +34,7 @@ options: WP-CLI packages dir: /home/person/.wp-cli/packages/ WP-CLI global config: WP-CLI project config: - WP-CLI version: 0.23.1 + WP-CLI version: 0.24.1 diff --git a/commands/cli/param-dump/index.md b/commands/cli/param-dump/index.md index ce82a8bf..dd71c077 100644 --- a/commands/cli/param-dump/index.md +++ b/commands/cli/param-dump/index.md @@ -28,6 +28,7 @@ options: ### EXAMPLES + # Dump the list of global parameters. $ wp cli param-dump --format=var_export array ( 'path' => diff --git a/commands/cli/update/index.md b/commands/cli/update/index.md index 0182bf7f..542c1a90 100644 --- a/commands/cli/update/index.md +++ b/commands/cli/update/index.md @@ -6,36 +6,52 @@ display_global_parameters: true [Commands](/commands/) » [cli](/commands/cli/) » update -`wp cli update` - Fetch most recent update matching the requirements. Returns the available versions if there are updates, or empty if no update available. +`wp cli update` - Update WP-CLI. Quick links: Github issues
+Default behavior is to check the releases API for a newer version, and +prompt if one is available. + +Use `--stable` to install or reinstall the latest stable version. + +Use `--nightly` to install the latest built version of the master branch. +While not recommended for production, nightly contains the latest and +greatest, and should be stable enough for development and staging +environments. + +Only works for the Phar installation mechanism. + ### OPTIONS [\--patch] -: Only perform patch updates +: Only perform patch updates. [\--minor] -: Only perform minor updates +: Only perform minor updates. [\--major] -: Only perform major updates +: Only perform major updates. + +[\--stable] +: Update to the latest stable release. Skips update check. [\--nightly] : Update to the latest built version of the master branch. Potentially unstable. [\--yes] -: Do not prompt for confirmation +: Do not prompt for confirmation. ### EXAMPLES + # Update CLI. $ wp cli update - You have version 0.23.0. Would you like to update to 0.23.1? [y/n] y - Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.23.1/wp-cli-0.23.1.phar... + You have version 0.24.0. Would you like to update to 0.24.1? [y/n] y + Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar... New version works. Proceeding to replace. - Success: Updated WP-CLI to 0.23.1 + Success: Updated WP-CLI to 0.24.1. diff --git a/commands/cli/version/index.md b/commands/cli/version/index.md index d2d13abb..e2182e14 100644 --- a/commands/cli/version/index.md +++ b/commands/cli/version/index.md @@ -14,8 +14,9 @@ display_global_parameters: true ### EXAMPLES + # Display CLI version. $ wp cli version - WP-CLI 0.23.1 + WP-CLI 0.24.1 diff --git a/commands/comment/approve/index.md b/commands/comment/approve/index.md index 1590fe07..879ae2a7 100644 --- a/commands/comment/approve/index.md +++ b/commands/comment/approve/index.md @@ -19,8 +19,9 @@ display_global_parameters: true ### EXAMPLES + # Approve comment. $ wp comment approve 1337 - Success: Approved comment 1337 + Success: Approved comment 1337. diff --git a/commands/comment/count/index.md b/commands/comment/count/index.md index 74c40bcb..600431c2 100644 --- a/commands/comment/count/index.md +++ b/commands/comment/count/index.md @@ -19,7 +19,7 @@ display_global_parameters: true ### EXAMPLES - # Count comments on whole blog + # Count comments on whole blog. $ wp comment count approved: 33 spam: 3 @@ -29,7 +29,7 @@ display_global_parameters: true moderated: 1 total_comments: 37 - # Count comments in a post + # Count comments in a post. $ wp comment count 42 approved: 19 spam: 0 diff --git a/commands/comment/create/index.md b/commands/comment/create/index.md index 781869f6..06db3cd6 100644 --- a/commands/comment/create/index.md +++ b/commands/comment/create/index.md @@ -22,6 +22,7 @@ display_global_parameters: true ### EXAMPLES + # Create comment. $ wp comment create --comment_post_ID=15 --comment_content="hello blog" --comment_author="wp-cli" Success: Created comment 932. diff --git a/commands/comment/delete/index.md b/commands/comment/delete/index.md index 2b8deed4..e44e2362 100644 --- a/commands/comment/delete/index.md +++ b/commands/comment/delete/index.md @@ -22,11 +22,11 @@ display_global_parameters: true ### EXAMPLES - # Delete comment + # Delete comment. $ wp comment delete 1337 --force Success: Deleted comment 1337. - # Delete multiple comments + # Delete multiple comments. $ wp comment delete 1337 2341 --force Success: Deleted comment 1337. Success: Deleted comment 2341. diff --git a/commands/comment/exists/index.md b/commands/comment/exists/index.md index 0a97d7a7..347b7262 100644 --- a/commands/comment/exists/index.md +++ b/commands/comment/exists/index.md @@ -19,6 +19,7 @@ display_global_parameters: true ### EXAMPLES + # Check whether comment exists. $ wp comment exists 1337 Success: Comment with ID 1337 exists. diff --git a/commands/comment/generate/index.md b/commands/comment/generate/index.md index d94d0041..31c6c935 100644 --- a/commands/comment/generate/index.md +++ b/commands/comment/generate/index.md @@ -15,7 +15,10 @@ display_global_parameters: true ### OPTIONS [\--count=<number>] -: How many comments to generate. Default: 100 +: How many comments to generate? +\--- +default: 100 +\--- [\--post_id=<post-id>] : Assign comments to a specific post. @@ -31,8 +34,12 @@ options: ### EXAMPLES - # Add meta to every generated comment - $ wp comment generate --format=ids --count=3 | xargs -0 -d ' ' -I % wp comment meta add % foo bar + # Generate comments for the given post. + $ wp comment generate --format=ids --count=3 --post_id=123 + 138 139 140 + + # Add meta to every generated comment. + $ wp comment generate --format=ids --count=3 | xargs -d ' ' -I % wp comment meta add % foo bar Success: Added custom field. Success: Added custom field. Success: Added custom field. diff --git a/commands/comment/get/index.md b/commands/comment/get/index.md index f3154af9..c9e881b0 100644 --- a/commands/comment/get/index.md +++ b/commands/comment/get/index.md @@ -36,6 +36,7 @@ options: ### EXAMPLES + # Get comment. $ wp comment get 21 --field=content Thanks for all the comments, everyone! diff --git a/commands/comment/index.md b/commands/comment/index.md index b6dcf3d2..262c2610 100644 --- a/commands/comment/index.md +++ b/commands/comment/index.md @@ -14,15 +14,15 @@ display_global_parameters: true ### EXAMPLES - # Create comment + # Create comment. $ wp comment create --comment_post_ID=15 --comment_content="hello blog" --comment_author="wp-cli" Success: Created comment 932. - # Update comment + # Update comment. $ wp comment update 123 --comment_author='That Guy' Success: Updated comment 123. - # Delete comment + # Delete comment. $ wp comment delete 1337 --force Success: Deleted comment 1337. @@ -113,7 +113,7 @@ display_global_parameters: true url - Get comment url + Get comment URL. diff --git a/commands/comment/list/index.md b/commands/comment/list/index.md index 1722c9be..c14a5aa6 100644 --- a/commands/comment/list/index.md +++ b/commands/comment/list/index.md @@ -61,13 +61,13 @@ These fields are optionally available: ### EXAMPLES - # List comment IDs + # List comment IDs. $ wp comment list --field=ID 22 23 24 - # List comments of a post + # List comments of a post. $ wp comment list --post_id=1 --fields=ID,comment_date,comment_author +------------+---------------------+----------------+ | comment_ID | comment_date | comment_author | @@ -75,7 +75,7 @@ These fields are optionally available: | 1 | 2015-06-20 09:00:10 | Mr WordPress | +------------+---------------------+----------------+ - # List approved comments + # List approved comments. $ wp comment list --number=3 --status=approve --fields=ID,comment_date,comment_author +------------+---------------------+----------------+ | comment_ID | comment_date | comment_author | diff --git a/commands/comment/meta/add/index.md b/commands/comment/meta/add/index.md index bc658f2b..67bfd198 100644 --- a/commands/comment/meta/add/index.md +++ b/commands/comment/meta/add/index.md @@ -24,7 +24,13 @@ display_global_parameters: true : The value of the meta field. If ommited, the value is read from STDIN. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- diff --git a/commands/comment/meta/update/index.md b/commands/comment/meta/update/index.md index 8d96f581..04a7cb41 100644 --- a/commands/comment/meta/update/index.md +++ b/commands/comment/meta/update/index.md @@ -24,7 +24,13 @@ display_global_parameters: true : The new value. If ommited, the value is read from STDIN. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- diff --git a/commands/comment/recount/index.md b/commands/comment/recount/index.md index 3e1234de..46ba01e7 100644 --- a/commands/comment/recount/index.md +++ b/commands/comment/recount/index.md @@ -19,6 +19,7 @@ display_global_parameters: true ### EXAMPLES + # Recount comment for the post. $ wp comment recount 123 Updated post 123 comment count to 67. diff --git a/commands/comment/spam/index.md b/commands/comment/spam/index.md index ced5ab51..032d79be 100644 --- a/commands/comment/spam/index.md +++ b/commands/comment/spam/index.md @@ -19,6 +19,7 @@ display_global_parameters: true ### EXAMPLES + # Spam comment. $ wp comment spam 1337 Success: Marked as spam comment 1337. diff --git a/commands/comment/status/index.md b/commands/comment/status/index.md index a688a6d8..8273029a 100644 --- a/commands/comment/status/index.md +++ b/commands/comment/status/index.md @@ -19,6 +19,7 @@ display_global_parameters: true ### EXAMPLES + # Get status of comment. $ wp comment status 1337 approved diff --git a/commands/comment/trash/index.md b/commands/comment/trash/index.md index 0716cdc0..ef6a1cfb 100644 --- a/commands/comment/trash/index.md +++ b/commands/comment/trash/index.md @@ -19,6 +19,7 @@ display_global_parameters: true ### EXAMPLES + # Trash comment. $ wp comment trash 1337 Success: Trashed comment 1337. diff --git a/commands/comment/unapprove/index.md b/commands/comment/unapprove/index.md index efc4cf66..552b8481 100644 --- a/commands/comment/unapprove/index.md +++ b/commands/comment/unapprove/index.md @@ -19,8 +19,9 @@ display_global_parameters: true ### EXAMPLES + # Unapprove comment. $ wp comment unapprove 1337 - Success: Unapproved comment 1337 + Success: Unapproved comment 1337. diff --git a/commands/comment/unspam/index.md b/commands/comment/unspam/index.md index 11ea4f11..b908f133 100644 --- a/commands/comment/unspam/index.md +++ b/commands/comment/unspam/index.md @@ -19,6 +19,7 @@ display_global_parameters: true ### EXAMPLES + # Unspam comment. $ wp comment unspam 1337 Success: Unspammed comment 1337. diff --git a/commands/comment/untrash/index.md b/commands/comment/untrash/index.md index fe3caa81..b93e2fd6 100644 --- a/commands/comment/untrash/index.md +++ b/commands/comment/untrash/index.md @@ -19,6 +19,7 @@ display_global_parameters: true ### EXAMPLES + # Untrash comment. $ wp comment untrash 1337 Success: Untrashed comment 1337. diff --git a/commands/comment/update/index.md b/commands/comment/update/index.md index 93f2b593..97a191ab 100644 --- a/commands/comment/update/index.md +++ b/commands/comment/update/index.md @@ -22,6 +22,7 @@ display_global_parameters: true ### EXAMPLES + # Update comment. $ wp comment update 123 --comment_author='That Guy' Success: Updated comment 123. diff --git a/commands/comment/url/index.md b/commands/comment/url/index.md index c537963d..24c3fa55 100644 --- a/commands/comment/url/index.md +++ b/commands/comment/url/index.md @@ -6,7 +6,7 @@ display_global_parameters: true [Commands](/commands/) » [comment](/commands/comment/) » url -`wp comment url` - Get comment url +`wp comment url` - Get comment URL. Quick links: Github issues @@ -19,6 +19,7 @@ display_global_parameters: true ### EXAMPLES + # Get comment URL. $ wp comment url 123 http://example.com/about/page-with-comments/#comment-123 diff --git a/commands/core/install/index.md b/commands/core/install/index.md index 91e6f928..f9d81b7b 100644 --- a/commands/core/install/index.md +++ b/commands/core/install/index.md @@ -22,6 +22,10 @@ WordPress is installed in the `/wp` directory and your domain is wp.dev, then you'll need to run `wp option update siteurl http://wp.dev/wp` for your WordPress install to function properly. +Note: When using custom user tables (e.g. `CUSTOM_USER_TABLE`), the admin +email and password are ignored if the user_login already exists. If the +user_login doesn't exist, a new user will be created. + ### OPTIONS \--url=<url> diff --git a/commands/core/language/activate/index.md b/commands/core/language/activate/index.md index b857ed6a..fb35815a 100644 --- a/commands/core/language/activate/index.md +++ b/commands/core/language/activate/index.md @@ -15,5 +15,10 @@ display_global_parameters: true <language> : Language code to activate. +### EXAMPLES + + $ wp core language activate ja + Success: Language activated. + diff --git a/commands/core/language/install/index.md b/commands/core/language/install/index.md index 71ecc36c..661b9cef 100644 --- a/commands/core/language/install/index.md +++ b/commands/core/language/install/index.md @@ -18,5 +18,10 @@ display_global_parameters: true [\--activate] : If set, the language will be activated immediately after install. +### EXAMPLES + + $ wp core language install ja + Success: Language installed. + diff --git a/commands/core/language/list/index.md b/commands/core/language/list/index.md index 822a1800..f273e95b 100644 --- a/commands/core/language/list/index.md +++ b/commands/core/language/list/index.md @@ -40,5 +40,15 @@ These fields are optionally available: * version * package +### EXAMPLES + + $ wp core language list --fields=language,english_name,status + +----------------+-------------------------+-------------+ + | language | english_name | status | + +----------------+-------------------------+-------------+ + | ar | Arabic | uninstalled | + | ary | Moroccan Arabic | uninstalled | + | az | Azerbaijani | uninstalled | + diff --git a/commands/core/language/uninstall/index.md b/commands/core/language/uninstall/index.md index 02dbd941..c44f0e59 100644 --- a/commands/core/language/uninstall/index.md +++ b/commands/core/language/uninstall/index.md @@ -15,5 +15,10 @@ display_global_parameters: true <language> : Language code to uninstall. +### EXAMPLES + + $ wp core language uninstall ja + Success: Language uninstalled. + diff --git a/commands/core/language/update/index.md b/commands/core/language/update/index.md index a5f21ef9..a1dbd8bf 100644 --- a/commands/core/language/update/index.md +++ b/commands/core/language/update/index.md @@ -15,5 +15,16 @@ display_global_parameters: true [\--dry-run] : Preview which translations would be updated. +### EXAMPLES + + $ wp core language update + 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 Twenty Fifteen 1.5... + Downloading translation from https://downloads.wordpress.org/translation/theme/twentyfifteen/1.5/ja.zip... + Translation updated successfully. + Success: Updated 2/2 translations. + diff --git a/commands/core/version/index.md b/commands/core/version/index.md index c085ef44..06020740 100644 --- a/commands/core/version/index.md +++ b/commands/core/version/index.md @@ -28,6 +28,7 @@ display_global_parameters: true WordPress version: 4.5.2 Database revision: 36686 TinyMCE version: 4.310 (4310-20160418) + Package language: en_US diff --git a/commands/db/check/index.md b/commands/db/check/index.md new file mode 100644 index 00000000..0b13664f --- /dev/null +++ b/commands/db/check/index.md @@ -0,0 +1,28 @@ +--- +layout: default +title: 'wp db check' +display_global_parameters: true +--- + +[Commands](/commands/) » [db](/commands/db/) » check + +`wp db check` - Check the database in MySQL. + +Quick links: Github issues + +
+ +Runs `mysqlcheck` utility with `--check` using `DB_HOST`, +`DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials +specified in wp-config.php. + +[See docs](http://dev.mysql.com/doc/refman/5.7/en/check-table.html) +for more details on the `CHECK TABLE` statement. + +### EXAMPLES + + $ wp db check + Success: Database checked. + + + diff --git a/commands/db/import/index.md b/commands/db/import/index.md index 6881d0d8..758112f1 100644 --- a/commands/db/import/index.md +++ b/commands/db/import/index.md @@ -12,6 +12,11 @@ display_global_parameters: true
+Runs MySQL queries using `DB_HOST`, `DB_NAME`, `DB_USER` and +`DB_PASSWORD` database credentials specified in wp-config.php. This +does not create database by itself and only performs whatever tasks are +defined in the SQL. + ### OPTIONS [<file>] @@ -19,6 +24,7 @@ display_global_parameters: true ### EXAMPLES + # Import MySQL from a file. $ wp db import wordpress_dbase.sql Success: Imported from 'wordpress_dbase.sql'. diff --git a/commands/db/index.md b/commands/db/index.md index 66045e3d..67018ada 100644 --- a/commands/db/index.md +++ b/commands/db/index.md @@ -41,6 +41,10 @@ display_global_parameters: true + + check + Check the database in MySQL. + cli Open a MySQL console using credentials from wp-config.php diff --git a/commands/db/optimize/index.md b/commands/db/optimize/index.md index a8e67a10..10a85056 100644 --- a/commands/db/optimize/index.md +++ b/commands/db/optimize/index.md @@ -17,7 +17,7 @@ Runs `mysqlcheck` utility with `--optimize=true` using `DB_HOST`, specified in wp-config.php. [See docs](http://dev.mysql.com/doc/refman/5.7/en/optimize-table.html) -for more details on the `OPTIMIZE_TABLE` statement. +for more details on the `OPTIMIZE TABLE` statement. ### EXAMPLES diff --git a/commands/db/query/index.md b/commands/db/query/index.md index 5ba0de9d..16528695 100644 --- a/commands/db/query/index.md +++ b/commands/db/query/index.md @@ -20,6 +20,9 @@ Executes an arbitrary MySQL query using `DB_HOST`, `DB_NAME`, `DB_USER` [<sql>] : A SQL query. If not passed, will try to read from STDIN. +[\--<field>=<value>] +: Extra arguments to pass to mysql. + ### EXAMPLES # Execute a query stored in a file @@ -44,5 +47,11 @@ Executes an arbitrary MySQL query using `DB_HOST`, `DB_NAME`, `DB_USER` | wordpress_dbase.wp_commentmeta | check | status | OK | +---------------------------------------+-------+----------+----------+ + # Pass extra arguments through to MySQL + $ wp db query 'SELECT * FROM wp_options WHERE option_name="home"' --skip-column-names + +---+------+------------------------------+-----+ + | 2 | home | http://wordpress-develop.dev | yes | + +---+------+------------------------------+-----+ + diff --git a/commands/db/repair/index.md b/commands/db/repair/index.md index 2280e92c..ebf054d2 100644 --- a/commands/db/repair/index.md +++ b/commands/db/repair/index.md @@ -17,7 +17,7 @@ Runs `mysqlcheck` utility with `--repair=true` using `DB_HOST`, specified in wp-config.php. [See docs](http://dev.mysql.com/doc/refman/5.7/en/repair-table.html) for -more details on the `REPAIR_TABLE` statement. +more details on the `REPAIR TABLE` statement. ### EXAMPLES diff --git a/commands/db/tables/index.md b/commands/db/tables/index.md index 7b29fc65..d02457a8 100644 --- a/commands/db/tables/index.md +++ b/commands/db/tables/index.md @@ -32,7 +32,13 @@ Defaults to all tables registered to $wpdb. : List all tables in the database, regardless of the prefix, and even if not registered on $wpdb. Overrides --all-tables-with-prefix. [\--format=<format>] -: Accepted values: list, csv. Default: list +: Render output in a particular format. +\--- +default: list +options: + - list + - csv +\--- ### EXAMPLES diff --git a/commands/eval/index.md b/commands/eval/index.md index 82c1e2dd..7511ec0e 100644 --- a/commands/eval/index.md +++ b/commands/eval/index.md @@ -20,5 +20,15 @@ display_global_parameters: true [\--skip-wordpress] : Execute code without loading WordPress. +### EXAMPLES + + # Display WordPress content directory. + $ wp eval 'echo WP_CONTENT_DIR;' + /var/www/wordpress/wp-content + + # Generate a random number. + $ wp eval 'echo rand();' --skip-wordpress + 479620423 + diff --git a/commands/media/import/index.md b/commands/media/import/index.md index 07b987ea..c9b96be9 100644 --- a/commands/media/import/index.md +++ b/commands/media/import/index.md @@ -20,48 +20,48 @@ display_global_parameters: true downloaded to a temp file before being sideloaded. [\--post_id=<post_id>] -: ID of the post to attach the imported files to +: ID of the post to attach the imported files to. [\--title=<title>] -: Attachment title (post title field) +: Attachment title (post title field). [\--caption=<caption>] -: Caption for attachent (post excerpt field) +: Caption for attachent (post excerpt field). [\--alt=<alt_text>] -: Alt text for image (saved as post meta) +: Alt text for image (saved as post meta). [\--desc=<description>] -: "Description" field (post content) of attachment post +: "Description" field (post content) of attachment post. [\--featured_image] : If set, set the imported image as the Featured Image of the post its attached to. [\--porcelain] -: Output just the new attachment id. +: Output just the new attachment ID. ### EXAMPLES - # Import all jpgs in the current user's "Pictures" directory, not attached to any post + # Import all jpgs in the current user's "Pictures" directory, not attached to any post. $ wp media import ~/Pictures/**\/*.jpg - Success: Imported file /home/person/Pictures/beautiful-youg-girl-in-ivy.jpg as attachment ID 1751. - Success: Imported file /home/person/Pictures/fashion-girl.jpg as attachment ID 1752. + Success: Imported file '/home/person/Pictures/beautiful-youg-girl-in-ivy.jpg' as attachment ID 1751. + Success: Imported file '/home/person/Pictures/fashion-girl.jpg' as attachment ID 1752. - # Import a local image and set it to be the post thumbnail for a post + # Import a local image and set it to be the post thumbnail for a post. $ wp media import ~/Downloads/image.png --post_id=123 --title="A downloaded picture" --featured_image - Success: Imported file /home/person/Downloads/image.png as attachment ID 1753 and attached to post 123 as featured image. + Success: Imported file '/home/person/Downloads/image.png' as attachment ID 1753 and attached to post 123 as featured image. - # Import a local image, but set it as the featured image for all posts - # 1. Import the image and get its attachment ID - # 2. Assign the attachment ID as the featured image for all posts + # Import a local image, but set it as the featured image for all posts. + # 1. Import the image and get its attachment ID. + # 2. Assign the attachment ID as the featured image for all posts. $ ATTACHMENT_ID="$(wp media import ~/Downloads/image.png --porcelain)" - $ wp post list --post_type=post --format=ids | xargs -0 -d ' ' -I % wp post meta add % _thumbnail_id $ATTACHMENT_ID + $ wp post list --post_type=post --format=ids | xargs -d ' ' -I % wp post meta add % _thumbnail_id $ATTACHMENT_ID Success: Added custom field. Success: Added custom field. - # Import an image from the web + # Import an image from the web. $ wp media import http://s.wordpress.org/style/images/wp-header-logo.png --title='The WordPress logo' --alt="Semantic personal publishing" - Success: Imported file http://s.wordpress.org/style/images/wp-header-logo.png as attachment ID 1755. + Success: Imported file 'http://s.wordpress.org/style/images/wp-header-logo.png' as attachment ID 1755. diff --git a/commands/media/index.md b/commands/media/index.md index e37cf4f5..264b408c 100644 --- a/commands/media/index.md +++ b/commands/media/index.md @@ -14,17 +14,17 @@ display_global_parameters: true ### EXAMPLES - # Re-generate all thumbnails, without confirmation + # Re-generate all thumbnails, without confirmation. $ wp media regenerate --yes Found 3 images to regenerate. - Regenerated thumbnails for "Sydney Harbor Bridge" (ID 760). - Regenerated thumbnails for "Boardwalk" (ID 757). - Regenerated thumbnails for "Sunburst Over River" (ID 756). + 1/3 Regenerated thumbnails for "Sydney Harbor Bridge" (ID 760). + 2/3 Regenerated thumbnails for "Boardwalk" (ID 757). + 3/3 Regenerated thumbnails for "Sunburst Over River" (ID 756). Success: Finished regenerating all images. - # Import a local image and set it to be the featured image for a post + # Import a local image and set it to be the featured image for a post. $ wp media import ~/Downloads/image.png --post_id=123 --title="A downloaded picture" --featured_image - Success: Imported file /home/person/Downloads/image.png as attachment ID 1753 and attached to post 123 as featured image. + Success: Imported file '/home/person/Downloads/image.png' as attachment ID 1753 and attached to post 123 as featured image. diff --git a/commands/media/regenerate/index.md b/commands/media/regenerate/index.md index 96304f19..972fe55f 100644 --- a/commands/media/regenerate/index.md +++ b/commands/media/regenerate/index.md @@ -24,25 +24,33 @@ display_global_parameters: true : Only generate thumbnails for images missing image sizes. [\--yes] -: Answer yes to the confirmation message. +: Answer yes to the confirmation message. Confirmation only shows when no IDs passed as arguments. ### EXAMPLES - # Re-generate all thumbnails, without confirmation + # Regenerate thumbnails for given attachment IDs. + $ wp media regenerate 123 124 125 + Found 3 images to regenerate. + 1/3 Regenerated thumbnails for "Vertical Image" (ID 123). + 2/3 Regenerated thumbnails for "Horizontal Image" (ID 124). + 3/3 Regenerated thumbnails for "Beautiful Picture" (ID 125). + Success: Finished regenerating all images. + + # Regenerate all thumbnails, without confirmation. $ wp media regenerate --yes Found 3 images to regenerate. - Regenerated thumbnails for "Sydney Harbor Bridge" (ID 760). - Regenerated thumbnails for "Boardwalk" (ID 757). - Regenerated thumbnails for "Sunburst Over River" (ID 756). + 1/3 Regenerated thumbnails for "Sydney Harbor Bridge" (ID 760). + 2/3 Regenerated thumbnails for "Boardwalk" (ID 757). + 3/3 Regenerated thumbnails for "Sunburst Over River" (ID 756). Success: Finished regenerating all images. - # Re-generate all thumbnails that have IDs between 1000 and 2000 + # Re-generate all thumbnails that have IDs between 1000 and 2000. $ seq 1000 2000 | xargs wp media regenerate Found 4 images to regenerate. - Regenerated thumbnails for "Vertical Featured Image" (ID 1027). - Regenerated thumbnails for "Horizontal Featured Image" (ID 1022). - Regenerated thumbnails for "Unicorn Wallpaper" (ID 1045). - Regenerated thumbnails for "I Am Worth Loving Wallpaper" (ID 1023). + 1/4 Regenerated thumbnails for "Vertical Featured Image" (ID 1027). + 2/4 Regenerated thumbnails for "Horizontal Featured Image" (ID 1022). + 3/4 Regenerated thumbnails for "Unicorn Wallpaper" (ID 1045). + 4/4 Regenerated thumbnails for "I Am Worth Loving Wallpaper" (ID 1023). Success: Finished regenerating all images. diff --git a/commands/menu/delete/index.md b/commands/menu/delete/index.md index 45d095eb..8b000231 100644 --- a/commands/menu/delete/index.md +++ b/commands/menu/delete/index.md @@ -20,7 +20,7 @@ display_global_parameters: true ### EXAMPLES $ wp menu delete "My Menu" - Success: Menu(s) deleted. + Success: 1 menu deleted. diff --git a/commands/menu/item/delete/index.md b/commands/menu/item/delete/index.md index ff3d1218..7b0e1048 100644 --- a/commands/menu/item/delete/index.md +++ b/commands/menu/item/delete/index.md @@ -20,7 +20,7 @@ display_global_parameters: true ### EXAMPLES $ wp menu item delete 45 - Success: Menu item(s) deleted. + Success: 1 menu item deleted. diff --git a/commands/menu/item/index.md b/commands/menu/item/index.md index 5d05eeda..f34caffe 100644 --- a/commands/menu/item/index.md +++ b/commands/menu/item/index.md @@ -24,7 +24,7 @@ display_global_parameters: true # Delete menu item $ wp menu item delete 45 - Success: Menu item(s) deleted. + Success: 1 menu item deleted. diff --git a/commands/network/meta/add/index.md b/commands/network/meta/add/index.md index 1a06333f..5532a81a 100644 --- a/commands/network/meta/add/index.md +++ b/commands/network/meta/add/index.md @@ -24,7 +24,13 @@ display_global_parameters: true : The value of the meta field. If ommited, the value is read from STDIN. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- diff --git a/commands/network/meta/update/index.md b/commands/network/meta/update/index.md index e2d2e492..e5fb9934 100644 --- a/commands/network/meta/update/index.md +++ b/commands/network/meta/update/index.md @@ -24,7 +24,13 @@ display_global_parameters: true : The new value. If ommited, the value is read from STDIN. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- diff --git a/commands/option/add/index.md b/commands/option/add/index.md index 8f9694d0..abcbe8fa 100644 --- a/commands/option/add/index.md +++ b/commands/option/add/index.md @@ -32,10 +32,9 @@ options: [\--autoload=<autoload>] : Should this option be automatically loaded. \--- -default: yes options: - - yes - - no + - 'yes' + - 'no' \--- ### EXAMPLES diff --git a/commands/option/list/index.md b/commands/option/list/index.md index 6a8bf429..868cb2fe 100644 --- a/commands/option/list/index.md +++ b/commands/option/list/index.md @@ -17,9 +17,15 @@ display_global_parameters: true [\--search=<pattern>] : Use wildcards ( * and ? ) to match option name. +[\--exclude=<pattern>] +: Pattern to exclude. Use wildcards ( * and ? ) to match option name. + [\--autoload=<value>] : Match only autoload options when value is on, and only not-autoload option when off. +[\--transients] +: List only transients. Use `--no-transients` to ignore all transients. + [\--field=<field>] : Prints the value of a single field. @@ -75,9 +81,9 @@ These fields are optionally available: +-------------+--------------+ # Delete all options begining with "theme_mods_" - $ wp option list --search="theme_mods_*" --field=option_name | xargs -0 -d '\n' -I % wp option delete % + $ wp option list --search="theme_mods_*" --field=option_name | xargs -I % wp option delete % Success: Deleted 'theme_mods_twentysixteen' option. - Success: Deleted 'theme_mods_twentfifteen' option. + Success: Deleted 'theme_mods_twentyfifteen' option. Success: Deleted 'theme_mods_twentyfourteen' option. diff --git a/commands/option/update/index.md b/commands/option/update/index.md index b364d80b..6c276eb7 100644 --- a/commands/option/update/index.md +++ b/commands/option/update/index.md @@ -23,10 +23,9 @@ display_global_parameters: true [\--autoload=<autoload>] : Requires WP 4.2. Should this option be automatically loaded. \--- -default: yes options: - - yes - - no + - 'yes' + - 'no' \--- [\--format=<format>] diff --git a/commands/package/browse/index.md b/commands/package/browse/index.md index 2cd20bda..ef6255eb 100644 --- a/commands/package/browse/index.md +++ b/commands/package/browse/index.md @@ -16,6 +16,9 @@ Lists packages available for installation from the [Package Index](http://wp-cli ### OPTIONS +[\--fields=<fields>] +: Limit the output to specific fields. Defaults to all fields. + [\--format=<format>] : Render output in a particular format. \--- diff --git a/commands/package/index.md b/commands/package/index.md index a88e19ee..12907c76 100644 --- a/commands/package/index.md +++ b/commands/package/index.md @@ -33,7 +33,7 @@ Learn how to create your own command from the # Install the latest development version of the package $ wp package install wp-cli/server-command - Installing wp-cli/server-command (dev-master) + Installing package wp-cli/server-command (dev-master) Updating /home/person/.wp-cli/packages/composer.json to require the package... Using Composer to install the package... --- diff --git a/commands/package/install/index.md b/commands/package/install/index.md index d767921c..98fbf6f6 100644 --- a/commands/package/install/index.md +++ b/commands/package/install/index.md @@ -12,16 +12,33 @@ display_global_parameters: true
+Packages are required to be a valid Composer package, and can be +specified as: + +* Package name from WP-CLI's package index. +* Git URL accessible by the current shell user. +* Path to a directory on the local machine. +* Local or remote .zip file. + +When installing a local directory, WP-CLI simply registers a +reference to the directory. If you move or delete the directory, WP-CLI's +reference breaks. + +When installing a .zip file, WP-CLI extracts the package to +`~/.wp-cli/packages/local/<package-name>`. + ### OPTIONS -<name> -: Name of the package to install. Can optionally contain a version constraint. +<name|git|path|zip> +: Name, git URL, directory path, or .zip file for the package to install. +Names can optionally include a version constraint +(e.g. wp-cli/server-command:@stable). ### EXAMPLES - # Install the latest development version + # Install the latest development version from the package index. $ wp package install wp-cli/server-command - Installing wp-cli/server-command (dev-master) + Installing package wp-cli/server-command (dev-master) Updating /home/person/.wp-cli/packages/composer.json to require the package... Using Composer to install the package... --- @@ -37,8 +54,14 @@ display_global_parameters: true --- Success: Package installed successfully. - # Install the latest stable version + # Install the latest stable version. $ wp package install wp-cli/server-command:@stable + # Install a package hosted at a git URL. + $ wp package install git@github.com:runcommand/hook.git + + # Install a package in a .zip file. + $ wp package install google-sitemap-generator-cli.zip + diff --git a/commands/package/list/index.md b/commands/package/list/index.md index daa5fcf0..87a939d9 100644 --- a/commands/package/list/index.md +++ b/commands/package/list/index.md @@ -14,6 +14,9 @@ display_global_parameters: true ### OPTIONS +[\--fields=<fields>] +: Limit the output to specific fields. Defaults to all fields. + [\--format=<format>] : Render output in a particular format. \--- diff --git a/commands/plugin/install/index.md b/commands/plugin/install/index.md index d9e0e1ff..fab76432 100644 --- a/commands/plugin/install/index.md +++ b/commands/plugin/install/index.md @@ -65,5 +65,14 @@ for confirmation. Installing the plugin... Plugin installed successfully. + # Forcefully re-install all installed plugins + $ wp plugin install $(wp plugin list --field=name) --force + Installing Akismet (3.1.11) + Downloading install package from https://downloads.wordpress.org/plugin/akismet.3.1.11.zip... + Unpacking the package... + Installing the plugin... + Removing the old version of the plugin... + Plugin updated successfully + diff --git a/commands/plugin/list/index.md b/commands/plugin/list/index.md index a84b920e..7c871891 100644 --- a/commands/plugin/list/index.md +++ b/commands/plugin/list/index.md @@ -54,23 +54,24 @@ These fields are optionally available: ### 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"},{"name":"tinymce-templates","status":"active","update":"none","version":"4.4.3"},{"name":"wp-multibyte-patch","status":"active","update":"none","version":"2.4"},{"name":"wp-total-hacks","status":"active","update":"none","version":"2.0.1"}] - # List plugins on each site in a network - $ wp site list --field=url | xargs -n 1 -I % wp plugin list --url=% - +------------------------------+----------------+-----------+------------+ - | name | status | update | version | - +------------------------------+----------------+-----------+------------+ - | akismet | active-network | none | 3.1.11 | - | hello | inactive | none | 1.6 | - +------------------------------+----------------+-----------+------------+ - +------------------------------+----------------+-----------+------------+ - | name | status | update | version | - +------------------------------+----------------+-----------+------------+ - | akismet | active-network | none | 3.1.11 | - | hello | inactive | none | 1.6 | - +------------------------------+----------------+-----------+------------+ + # List plugins on each site in a network. + $ wp site list --field=url | xargs -I % wp plugin list --url=% + +---------+----------------+--------+---------+ + | name | status | update | version | + +---------+----------------+--------+---------+ + | akismet | active-network | none | 3.1.11 | + | hello | inactive | none | 1.6 | + +---------+----------------+--------+---------+ + +---------+----------------+--------+---------+ + | name | status | update | version | + +---------+----------------+--------+---------+ + | akismet | active-network | none | 3.1.11 | + | hello | inactive | none | 1.6 | + +---------+----------------+--------+---------+ diff --git a/commands/post/generate/index.md b/commands/post/generate/index.md index e6af0ec1..99ac9fec 100644 --- a/commands/post/generate/index.md +++ b/commands/post/generate/index.md @@ -61,19 +61,19 @@ options: ### EXAMPLES - # Generate posts + # Generate posts. $ wp post generate --count=10 --post_type=page --post_date=1999-01-04 Generating posts 100% [================================================] 0:01 / 0:04 - # Generate posts with fetched content + # Generate posts with fetched content. $ curl http://loripsum.net/api/5 | wp post generate --post_content --count=10 % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 2509 100 2509 0 0 616 0 0:00:04 0:00:04 --:--:-- 616 Generating posts 100% [================================================] 0:01 / 0:04 - # Add meta to every generated post - $ wp post generate --format=ids | xargs -0 -d ' ' -I % wp post meta add % foo bar + # Add meta to every generated posts. + $ wp post generate --format=ids | xargs -d ' ' -I % wp post meta add % foo bar Success: Added custom field. Success: Added custom field. Success: Added custom field. diff --git a/commands/post/list/index.md b/commands/post/list/index.md index a6b655d1..0e1c38a4 100644 --- a/commands/post/list/index.md +++ b/commands/post/list/index.md @@ -24,7 +24,7 @@ display_global_parameters: true : Limit the output to specific object fields. [\--format=<format>] -: Accepted values: table, csv, json, count, ids, yaml. Default: table +: Render output in a particular format. \--- default: table options: diff --git a/commands/post/meta/add/index.md b/commands/post/meta/add/index.md index f15ff154..b1ca7736 100644 --- a/commands/post/meta/add/index.md +++ b/commands/post/meta/add/index.md @@ -24,7 +24,13 @@ display_global_parameters: true : The value of the meta field. If ommited, the value is read from STDIN. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- diff --git a/commands/post/meta/update/index.md b/commands/post/meta/update/index.md index ccbb9b88..36b40f35 100644 --- a/commands/post/meta/update/index.md +++ b/commands/post/meta/update/index.md @@ -24,7 +24,13 @@ display_global_parameters: true : The new value. If ommited, the value is read from STDIN. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- diff --git a/commands/role/create/index.md b/commands/role/create/index.md index aacf501a..f29b87ce 100644 --- a/commands/role/create/index.md +++ b/commands/role/create/index.md @@ -25,13 +25,13 @@ display_global_parameters: true ### EXAMPLES - # Create role for Approver + # Create role for Approver. $ wp role create approver Approver - Success: Role with key approver created. + Success: Role with key 'approver' created. - # Create role for Product Administrator + # Create role for Product Administrator. $ wp role create productadmin "Product Administrator" - Success: Role with key productadmin created. + Success: Role with key 'productadmin' created. diff --git a/commands/role/delete/index.md b/commands/role/delete/index.md index 3704ca37..6b6a24a7 100644 --- a/commands/role/delete/index.md +++ b/commands/role/delete/index.md @@ -19,13 +19,13 @@ display_global_parameters: true ### EXAMPLES - # Delete approver role + # Delete approver role. $ wp role delete approver - Success: Role with key approver deleted. + Success: Role with key 'approver' deleted. - # Delete productadmin role + # Delete productadmin role. wp role delete productadmin - Success: Role with key productadmin deleted. + Success: Role with key 'productadmin' deleted. diff --git a/commands/role/exists/index.md b/commands/role/exists/index.md index 38a94f6b..b9e42d60 100644 --- a/commands/role/exists/index.md +++ b/commands/role/exists/index.md @@ -12,7 +12,7 @@ display_global_parameters: true
-##DESCRIPTION +### DESCRIPTION Will exit with status 0 if the role exists, 1 if it does not. @@ -23,8 +23,9 @@ Will exit with status 0 if the role exists, 1 if it does not. ### EXAMPLES + # Check if a role exists. $ wp role exists editor - Success: Role with ID editor exists. + Success: Role with ID 'editor' exists. diff --git a/commands/role/index.md b/commands/role/index.md index dbdf329b..cb25d1cf 100644 --- a/commands/role/index.md +++ b/commands/role/index.md @@ -14,7 +14,7 @@ display_global_parameters: true ### EXAMPLES - # List roles + # List roles. $ wp role list --fields=role --format=csv role administrator @@ -23,21 +23,21 @@ display_global_parameters: true contributor subscriber - # Check if a role exists + # Check if a role exists. $ wp role exists editor - Success: Role with ID editor exists. + Success: Role with ID 'editor' exists. - # Create role + # Create role. $ wp role create approver Approver - Success: Role with key approver created. + Success: Role with key 'approver' created. - # Delete role + # Delete role. $ wp role delete approver - Success: Role with key approver deleted. + Success: Role with key 'approver' deleted. - # Reset role + # Reset role. $ wp role reset administrator author contributor - Success: Reset 3/3 roles + Success: Reset 3/3 roles. diff --git a/commands/role/list/index.md b/commands/role/list/index.md index 92dab195..019fb259 100644 --- a/commands/role/list/index.md +++ b/commands/role/list/index.md @@ -40,6 +40,7 @@ There are no optional fields. ### EXAMPLES + # List roles. $ wp role list --fields=role --format=csv role administrator diff --git a/commands/role/reset/index.md b/commands/role/reset/index.md index 1f92dc7c..926b1440 100644 --- a/commands/role/reset/index.md +++ b/commands/role/reset/index.md @@ -22,11 +22,11 @@ display_global_parameters: true ### EXAMPLES - # Reset role + # Reset role. $ wp role reset administrator author contributor Success: Reset 1/3 roles. - # Reset all default roles + # Reset all default roles. $ wp role reset --all Success: All default roles reset. diff --git a/commands/scaffold/plugin-tests/index.md b/commands/scaffold/plugin-tests/index.md index e118cbfc..5a98da99 100644 --- a/commands/scaffold/plugin-tests/index.md +++ b/commands/scaffold/plugin-tests/index.md @@ -38,7 +38,7 @@ variable. : Generate test files for a non-standard plugin path. If no plugin slug is specified, the directory name is used. [\--ci=<provider>] -: Add a configuration file for a continuous integration provider. +: Choose a configuration file for a continuous integration provider. \--- default: travis options: diff --git a/commands/scaffold/plugin/index.md b/commands/scaffold/plugin/index.md index dd23600f..6b7a78e9 100644 --- a/commands/scaffold/plugin/index.md +++ b/commands/scaffold/plugin/index.md @@ -27,7 +27,7 @@ The following files are generated for your plugin by this command: The following files are also generated if tests are not skipped using `--skip-tests`: * `phpunit.xml.dist` is the configuration file for PHPUnit. -* `.travis.yml` is the configuration file for Travis CI. +* `.travis.yml` is the configuration file for Travis CI. Use `--ci=<provider>` to select a different service. * `bin/install-wp-tests.sh` configures the WordPress test suite and a test database. * `tests/bootstrap.php` is the file that makes the current plugin active when running the test suite. * `tests/test-sample.php` is a sample file containing test cases. @@ -58,6 +58,16 @@ The following files are also generated if tests are not skipped using `--skip-te [\--skip-tests] : Don't generate files for unit testing. +[\--ci=<provider>] +: Choose a configuration file for a continuous integration provider. +\--- +default: travis +options: + - travis + - circle + - gitlab +\--- + [\--activate] : Activate the newly generated plugin. diff --git a/commands/server/index.md b/commands/server/index.md index c5536b42..a1a1d230 100644 --- a/commands/server/index.md +++ b/commands/server/index.md @@ -31,6 +31,9 @@ default: 8080 [\--docroot=<path>] : The path to use as the document root. +[\--config=<file>] +: Configure the server with a specific .ini file. + ### EXAMPLES # Make the instance available on any address (with port 8080) @@ -47,5 +50,12 @@ default: 8080 Document root is / Press Ctrl-C to quit. + # Configure the server with a specific .ini file + $ wp server --config=development.ini + PHP 7.0.9 Development Server started at Mon Aug 22 12:09:04 2016 + Listening on http://localhost:8080 + Document root is / + Press Ctrl-C to quit. + diff --git a/commands/site/create/index.md b/commands/site/create/index.md index 13393adc..5032b4cd 100644 --- a/commands/site/create/index.md +++ b/commands/site/create/index.md @@ -35,7 +35,7 @@ display_global_parameters: true ### EXAMPLES $ wp site create --slug=example - Success: Site 3 created: www.example.com/example/ + Success: Site 3 created: http://www.example.com/example/ diff --git a/commands/site/index.md b/commands/site/index.md index 9ed130fe..b3d15bbf 100644 --- a/commands/site/index.md +++ b/commands/site/index.md @@ -68,6 +68,10 @@ display_global_parameters: true list List all sites in a multisite install. + + option + Manage site options. + spam Mark one or more sites as spam diff --git a/commands/site/option/add/index.md b/commands/site/option/add/index.md new file mode 100644 index 00000000..db2c458c --- /dev/null +++ b/commands/site/option/add/index.md @@ -0,0 +1,39 @@ +--- +layout: default +title: 'wp site option add' +display_global_parameters: true +--- + +[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » add + +`wp site option add` - Add a site option. + +Quick links: Github issues + +
+ +### OPTIONS + +<key> +: The name of the site option to add. + +[<value>] +: The value of the site option to add. If ommited, the value is read from STDIN. + +[\--format=<format>] +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- + +### EXAMPLES + + # Create a site option by reading a JSON file + $ wp site option add my_option --format=json < config.json + Success: Added 'my_option' site option. + + + diff --git a/commands/site/option/delete/index.md b/commands/site/option/delete/index.md new file mode 100644 index 00000000..8998de05 --- /dev/null +++ b/commands/site/option/delete/index.md @@ -0,0 +1,26 @@ +--- +layout: default +title: 'wp site option delete' +display_global_parameters: true +--- + +[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » delete + +`wp site option delete` - Delete a site option. + +Quick links: Github issues + +
+ +### OPTIONS + +<key> +: Key for the site option. + +### EXAMPLES + + $ wp site option delete my_option + Success: Deleted 'my_option' site option. + + + diff --git a/commands/site/option/get/index.md b/commands/site/option/get/index.md new file mode 100644 index 00000000..0bb9a888 --- /dev/null +++ b/commands/site/option/get/index.md @@ -0,0 +1,37 @@ +--- +layout: default +title: 'wp site option get' +display_global_parameters: true +--- + +[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » get + +`wp site option get` - Get a site option. + +Quick links: Github issues + +
+ +### OPTIONS + +<key> +: Key for the site option. + +[\--format=<format>] +: Get value in a particular format. +\--- +default: var_export +options: + - var_export + - json + - yaml +\--- + +### EXAMPLES + + # Get site upload filetypes + $ wp site option get upload_filetypes + jpg jpeg png gif mov avi mpg + + + diff --git a/commands/site/option/index.md b/commands/site/option/index.md new file mode 100644 index 00000000..5eb8b427 --- /dev/null +++ b/commands/site/option/index.md @@ -0,0 +1,68 @@ +--- +layout: default +title: 'wp site option' +display_global_parameters: true +--- + +[Commands](/commands/) » [site](/commands/site/) » option + +`wp site option` - Manage site options. + +Quick links: Github issues + +
+ +### EXAMPLES + + # Get site registration + $ wp site option get registration + none + + # Add site option + $ wp site option add my_option foobar + Success: Added 'my_option' site option. + + # Update site option + $ wp site option update my_option '{"foo": "bar"}' --format=json + Success: Updated 'my_option' site option. + + # Delete site option + $ wp site option delete my_option + Success: Deleted 'my_option' site option. + + + + + +### SUBCOMMANDS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
addAdd a site option.
deleteDelete a site option.
getGet a site option.
listList site options.
updateUpdate a site option.
diff --git a/commands/site/option/list/index.md b/commands/site/option/list/index.md new file mode 100644 index 00000000..095376b9 --- /dev/null +++ b/commands/site/option/list/index.md @@ -0,0 +1,63 @@ +--- +layout: default +title: 'wp site option list' +display_global_parameters: true +--- + +[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » list + +`wp site option list` - List site options. + +Quick links: Github issues + +
+ +### OPTIONS + +[\--search=<pattern>] +: Use wildcards ( * and ? ) to match option name. + +[\--field=<field>] +: Prints the value of a single field. + +[\--fields=<fields>] +: Limit the output to specific object fields. + +[\--format=<format>] +: The serialization format for the value. total_bytes displays the total size of matching options in bytes. +\--- +default: table +options: + - table + - json + - csv + - count + - yaml + - total_bytes +\--- + +### AVAILABLE FIELDS + +This field will be displayed by default for each matching option: + +* meta_key +* meta_value + +These fields are optionally available: + +* meta_id +* site_id +* size_bytes + +### EXAMPLES + + # List all site options begining with "i2f_" + $ wp site option list --search="i2f_*" + +-------------+--------------+ + | meta_key | meta_value | + +-------------+--------------+ + | i2f_version | 0.1.0 | + +-------------+--------------+ + + + diff --git a/commands/site/option/update/index.md b/commands/site/option/update/index.md new file mode 100644 index 00000000..532f21f4 --- /dev/null +++ b/commands/site/option/update/index.md @@ -0,0 +1,39 @@ +--- +layout: default +title: 'wp site option update' +display_global_parameters: true +--- + +[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » update + +`wp site option update` - Update a site option. + +Quick links: Github issues + +
+ +### OPTIONS + +<key> +: The name of the site option to update. + +[<value>] +: The new value. If ommited, the value is read from STDIN. + +[\--format=<format>] +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- + +### EXAMPLES + + # Update a site option by reading from a file + $ wp site option update my_option < value.txt + Success: Updated 'my_option' site option. + + + diff --git a/commands/taxonomy/get/index.md b/commands/taxonomy/get/index.md index c1e5a3fe..516b5f1b 100644 --- a/commands/taxonomy/get/index.md +++ b/commands/taxonomy/get/index.md @@ -12,10 +12,12 @@ display_global_parameters: true
+Displays detail of the taxonomy. + ### OPTIONS <taxonomy> -: Taxonomy slug +: Taxonomy slug. [\--field=<field>] : Instead of returning the whole taxonomy, returns the value of a single field. @@ -36,36 +38,17 @@ options: ### EXAMPLES - $ wp taxonomy get category - +---------------+---------------------------------------------------+ - | Field | Value | - +---------------+---------------------------------------------------+ - | name | category | - | label | Categories | - | description | | - | object_type | ["post"] | - | show_tagcloud | true | - | hierarchical | true | - | public | true | - | labels | {"name":"Categories","singular_name":"Category"," | - | | search_items":"Search Categories","popular_items" | - | | :null,"all_items":"All Categories","parent_item": | - | | "Parent Category","parent_item_colon":"Parent Cat | - | | egory:","edit_item":"Edit Category","view_item":" | - | | View Category","update_item":"Update Category","a | - | | dd_new_item":"Add New Category","new_item_name":" | - | | New Category Name","separate_items_with_commas":n | - | | ull,"add_or_remove_items":null,"choose_from_most_ | - | | used":null,"not_found":"No categories found.","no | - | | _terms":"No categories","items_list_navigation":" | - | | Categories list navigation","items_list":"Categor | - | | ies list","menu_name":"Categories","name_admin_ba | - | | r":"category"} | - | cap | {"manage_terms":"manage_categories","edit_terms": | - | | "manage_categories","delete_terms":"manage_catego | - | | ries","assign_terms":"edit_posts"} | - +---------------+---------------------------------------------------+ - + # Get details of `category` taxonomy. + $ wp taxonomy get category --fields=name,label,object_type + +-------------+------------+ + | Field | Value | + +-------------+------------+ + | name | category | + | label | Categories | + | object_type | ["post"] | + +-------------+------------+ + + # Get capabilities of 'post_tag' taxonomy. $ wp taxonomy get post_tag --field=cap {"manage_terms":"manage_categories","edit_terms":"manage_categories","delete_terms":"manage_categories","assign_terms":"edit_posts"} diff --git a/commands/taxonomy/index.md b/commands/taxonomy/index.md index f407197c..9803cb0f 100644 --- a/commands/taxonomy/index.md +++ b/commands/taxonomy/index.md @@ -14,7 +14,7 @@ display_global_parameters: true ### EXAMPLES - # List all taxonomies with 'post' object type + # List all taxonomies with 'post' object type. $ wp taxonomy list --object_type=post --fields=name,public +-------------+--------+ | name | public | @@ -24,7 +24,7 @@ display_global_parameters: true | post_format | 1 | +-------------+--------+ - # Get capabilities of a taxonomy + # Get capabilities of 'post_tag' taxonomy. $ wp taxonomy get post_tag --field=cap {"manage_terms":"manage_categories","edit_terms":"manage_categories","delete_terms":"manage_categories","assign_terms":"edit_posts"} @@ -42,7 +42,7 @@ display_global_parameters: true get - Get a taxonomy + Get a taxonomy. list diff --git a/commands/taxonomy/list/index.md b/commands/taxonomy/list/index.md index 84cf5cf2..13754aa4 100644 --- a/commands/taxonomy/list/index.md +++ b/commands/taxonomy/list/index.md @@ -12,6 +12,8 @@ display_global_parameters: true
+Displays list of registered taxonomies. + ### OPTIONS [\--<field>=<value>] @@ -49,7 +51,7 @@ There are no optionally available fields. ### EXAMPLES - # List all taxonomies + # List all taxonomies. $ wp taxonomy list --format=csv name,label,description,object_type,show_tagcloud,hierarchical,public category,Categories,,post,1,1,1 @@ -58,7 +60,7 @@ There are no optionally available fields. link_category,"Link Categories",,link,1,, post_format,Format,,post,,,1 - # List all taxonomies with 'post' object type + # List all taxonomies with 'post' object type. $ wp taxonomy list --object_type=post --fields=name,public +-------------+--------+ | name | public | diff --git a/commands/term/generate/index.md b/commands/term/generate/index.md index 09e58600..803635e6 100644 --- a/commands/term/generate/index.md +++ b/commands/term/generate/index.md @@ -18,10 +18,16 @@ display_global_parameters: true : The taxonomy for the generated terms. [\--count=<number>] -: How many terms to generate. Default: 100 +: How many terms to generate? +\--- +default: 100 +\--- [\--max_depth=<number>] -: Generate child terms down to a certain depth. Default: 1 +: Generate child terms down to a certain depth. +\--- +default: 1 +\--- [\--format=<format>] : Render output in a particular format. @@ -34,12 +40,12 @@ options: ### EXAMPLES - # Generate post categories + # Generate post categories. $ wp term generate category --count=10 Generating terms 100% [=========] 0:02 / 0:02 - # Add meta to every generated term - $ wp term generate category --format=ids --count=3 | xargs -0 -d ' ' -I % wp term meta add % foo bar + # Add meta to every generated term. + $ wp term generate category --format=ids --count=3 | xargs -d ' ' -I % wp term meta add % foo bar Success: Added custom field. Success: Added custom field. Success: Added custom field. diff --git a/commands/term/meta/add/index.md b/commands/term/meta/add/index.md index f0b50836..6a607bad 100644 --- a/commands/term/meta/add/index.md +++ b/commands/term/meta/add/index.md @@ -24,7 +24,13 @@ display_global_parameters: true : The value of the meta field. If ommited, the value is read from STDIN. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- diff --git a/commands/term/meta/update/index.md b/commands/term/meta/update/index.md index f6e33cde..fe8d1085 100644 --- a/commands/term/meta/update/index.md +++ b/commands/term/meta/update/index.md @@ -24,7 +24,13 @@ display_global_parameters: true : The new value. If ommited, the value is read from STDIN. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- diff --git a/commands/theme/get/index.md b/commands/theme/get/index.md index 6aa98340..45ade919 100644 --- a/commands/theme/get/index.md +++ b/commands/theme/get/index.md @@ -24,7 +24,15 @@ display_global_parameters: true : Limit the output to specific fields. Defaults to all fields. [\--format=<format>] -: Accepted values: table, json, csv, yaml. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- ### EXAMPLES diff --git a/commands/theme/list/index.md b/commands/theme/list/index.md index dc8bacf6..5da161de 100644 --- a/commands/theme/list/index.md +++ b/commands/theme/list/index.md @@ -24,7 +24,16 @@ display_global_parameters: true : Limit the output to specific object fields. [\--format=<format>] -: Accepted values: table, json, csv, yaml. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - count + - yaml +\--- ### AVAILABLE FIELDS diff --git a/commands/theme/search/index.md b/commands/theme/search/index.md index 6d3348e4..b52bcc31 100644 --- a/commands/theme/search/index.md +++ b/commands/theme/search/index.md @@ -38,7 +38,16 @@ display_global_parameters: true **description**: Theme Description [\--format=<format>] -: Accepted values: table, csv, json, count, yaml. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - count + - yaml +\--- ### EXAMPLES diff --git a/commands/transient/delete/index.md b/commands/transient/delete/index.md index e688757d..d6ac4984 100644 --- a/commands/transient/delete/index.md +++ b/commands/transient/delete/index.md @@ -14,16 +14,31 @@ display_global_parameters: true ### OPTIONS -<key> +[<key>] : Key for the transient. [\--network] : Delete the value of a network transient, instead of that on a single site. +[\--all] +: Delete all transients. + +[\--expired] +: Delete all expired transients. + ### EXAMPLES + # Delete transient. $ wp transient delete sample_key Success: Transient deleted. + # Delete expired transients. + $ wp transient delete --expired + Success: 12 expired transients deleted from the database. + + # Delete all transients. + $ wp transient delete --all + Success: 14 transients deleted from the database. + diff --git a/commands/transient/index.md b/commands/transient/index.md index 2bbfc47e..b8a4c6a1 100644 --- a/commands/transient/index.md +++ b/commands/transient/index.md @@ -14,24 +14,24 @@ display_global_parameters: true ### EXAMPLES - # Set transient + # Set transient. $ wp transient set sample_key "test data" 3600 Success: Transient added. - # Get transient + # Get transient. $ wp transient get sample_key test data - # Delete transient + # Delete transient. $ wp transient delete sample_key Success: Transient deleted. - # Delete expired transients - $ wp transient delete-expired + # Delete expired transients. + $ wp transient delete --expired Success: 12 expired transients deleted from the database. - # Delete all transients - $ wp transient delete-all + # Delete all transients. + $ wp transient delete --all Success: 14 transients deleted from the database. @@ -50,14 +50,6 @@ display_global_parameters: true delete Delete a transient value. - - delete-all - Delete all transients. - - - delete-expired - Delete all expired transients. - get Get a transient value. diff --git a/commands/user/generate/index.md b/commands/user/generate/index.md index 7209dc4e..7cd1a02e 100644 --- a/commands/user/generate/index.md +++ b/commands/user/generate/index.md @@ -15,18 +15,27 @@ display_global_parameters: true ### OPTIONS [\--count=<number>] -: How many users to generate. Default: 100 +: How many users to generate? +\--- +default: 100 +\--- [\--role=<role>] : The role of the generated users. Default: default role from WP [\--format=<format>] -: Accepted values: progress, ids. Default: ids. +: Render output in a particular format. +\--- +default: progress +options: + - progress + - ids +\--- ### EXAMPLES - # Add meta to every generated user - $ wp user generate --format=ids --count=3 | xargs -0 -d ' ' -I % wp user meta add % foo bar + # Add meta to every generated users. + $ wp user generate --format=ids --count=3 | xargs -d ' ' -I % wp user meta add % foo bar Success: Added custom field. Success: Added custom field. Success: Added custom field. diff --git a/commands/user/get/index.md b/commands/user/get/index.md index b5c55efa..a0198b55 100644 --- a/commands/user/get/index.md +++ b/commands/user/get/index.md @@ -24,7 +24,15 @@ display_global_parameters: true : Get a specific subset of the user's fields. [\--format=<format>] -: Accepted values: table, json, csv, yaml. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- ### EXAMPLES diff --git a/commands/user/index.md b/commands/user/index.md index c9c4eed4..c9687d3f 100644 --- a/commands/user/index.md +++ b/commands/user/index.md @@ -91,6 +91,10 @@ display_global_parameters: true remove-role Remove a user's role. + + session + Manage a user's sessions. + set-role Set the user role (for a particular blog). diff --git a/commands/user/list/index.md b/commands/user/list/index.md index 2c7aca7c..854fb9e9 100644 --- a/commands/user/list/index.md +++ b/commands/user/list/index.md @@ -30,7 +30,17 @@ display_global_parameters: true : Limit the output to specific object fields. [\--format=<format>] -: Accepted values: table, csv, json, count, yaml. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - ids + - json + - count + - yaml +\--- ### AVAILABLE FIELDS diff --git a/commands/user/meta/get/index.md b/commands/user/meta/get/index.md index 5894d062..fc728092 100644 --- a/commands/user/meta/get/index.md +++ b/commands/user/meta/get/index.md @@ -21,7 +21,15 @@ display_global_parameters: true : The metadata key. [\--format=<format>] -: Accepted values: table, json, yaml. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- ### EXAMPLES diff --git a/commands/user/meta/list/index.md b/commands/user/meta/list/index.md index f84f144a..e8d25bed 100644 --- a/commands/user/meta/list/index.md +++ b/commands/user/meta/list/index.md @@ -14,8 +14,8 @@ display_global_parameters: true ### OPTIONS -<id> -: ID for the object. +<user> +: The user login, user email, or user ID of the user to get metadata for. [\--keys=<keys>] : Limit output to metadata of specific keys. @@ -24,7 +24,16 @@ display_global_parameters: true : Limit the output to specific row fields. Defaults to id,meta_key,meta_value. [\--format=<format>] -: Accepted values: table, csv, json, count. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - count + - yaml +\--- ### EXAMPLES diff --git a/commands/user/session/destroy/index.md b/commands/user/session/destroy/index.md new file mode 100644 index 00000000..0c61c502 --- /dev/null +++ b/commands/user/session/destroy/index.md @@ -0,0 +1,46 @@ +--- +layout: default +title: 'wp user session destroy' +display_global_parameters: true +--- + +[Commands](/commands/) » [user](/commands/user/) » [session](/commands/user/session/) » destroy + +`wp user session destroy` - Destroy a session for the given user. + +Quick links: Github issues + +
+ +### OPTIONS + +<user> +: User ID, user email, or user login. + +[<token>] +: The token of the session to destroy. Defaults to the most recently created session. + +[\--all] +: Destroy all of the user's sessions. + +### EXAMPLES + + # Destroy the most recent session of the given user + $ wp user session destroy admin + Success: Destroyed session. 3 sessions remaining. + + # Destroy a specific session of the given user + $ wp user session destroy admin e073ad8540a9c2... + Success: Destroyed session. 2 sessions remaining. + + # Destroy all the sessions of the given user + $ wp user session destroy admin --all + Success: Destroyed all sessions. + + # Destroy all sessions for all users + $ wp user list --field=ID | xargs wp user session destroy --all + Success: Destroyed all sessions. 0 remaining. + Success: Destroyed all sessions. 0 remaining. + + + diff --git a/commands/user/session/index.md b/commands/user/session/index.md new file mode 100644 index 00000000..66445e73 --- /dev/null +++ b/commands/user/session/index.md @@ -0,0 +1,40 @@ +--- +layout: default +title: 'wp user session' +display_global_parameters: true +--- + +[Commands](/commands/) » [user](/commands/user/) » session + +`wp user session` - Manage a user's sessions. + +Quick links: Github issues + +
+ +### EXAMPLES + + + + + +### SUBCOMMANDS + + + + + + + + + + + + + + + + + + +
NameDescription
destroyDestroy a session for the given user.
listList sessions for the given user.
diff --git a/commands/user/session/list/index.md b/commands/user/session/list/index.md new file mode 100644 index 00000000..205c3280 --- /dev/null +++ b/commands/user/session/list/index.md @@ -0,0 +1,59 @@ +--- +layout: default +title: 'wp user session list' +display_global_parameters: true +--- + +[Commands](/commands/) » [user](/commands/user/) » [session](/commands/user/session/) » list + +`wp user session list` - List sessions for the given user. + +Quick links: Github issues + +
+ +### OPTIONS + +<user> +: User ID, user email, or user login. + +[\--fields=<fields>] +: Limit the output to specific fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml + - count + - ids +\--- + +### AVAILABLE FIELDS + +These fields will be displayed by default for each session: + +* token +* login_time +* expiration_time +* ip +* ua + +These fields are optionally available: + +* expiration +* login + +### EXAMPLES + + # List a user's sessions + $ wp user session list admin@example.com --format=csv + login_time,expiration_time,ip,ua + "2016-01-01 12:34:56","2016-02-01 12:34:56",127.0.0.1,"Mozilla/5.0..." + + + diff --git a/commands/widget/deactivate/index.md b/commands/widget/deactivate/index.md index a9a2ab8e..8edf992d 100644 --- a/commands/widget/deactivate/index.md +++ b/commands/widget/deactivate/index.md @@ -20,7 +20,7 @@ display_global_parameters: true ### EXAMPLES $ wp widget deactivate recent-comments-2 - Success: Widget(s) deactivated. + Success: 1 widget deactivated. diff --git a/commands/widget/delete/index.md b/commands/widget/delete/index.md index a4727eab..161f7781 100644 --- a/commands/widget/delete/index.md +++ b/commands/widget/delete/index.md @@ -20,7 +20,7 @@ display_global_parameters: true ### EXAMPLES $ wp widget delete recent-comments-2 - Success: Widget(s) removed from sidebar. + Success: 1 widget removed from sidebar. diff --git a/commands/widget/index.md b/commands/widget/index.md index 5d7ab5e9..1822be30 100644 --- a/commands/widget/index.md +++ b/commands/widget/index.md @@ -33,7 +33,7 @@ display_global_parameters: true # Delete one or more widgets entirely $ wp widget delete calendar-2 archive-1 - Success: Widget(s) removed from sidebar. + Success: 2 widgets removed from sidebar. From 69b17486149764f03be9186080d18c3d89a60909 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 12:03:57 -0700 Subject: [PATCH 14/17] Fix typo --- _posts/2016-10-25-version-0.25.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 7663aaf0..5ff822c3 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -75,7 +75,7 @@ Command improvements: * Adds comments to generated `wp-config.php` to better match the one provided by WordPress core [[#3312](https://github.com/wp-cli/wp-cli/pull/3312)]. * `wp core download`: * Preserves case for `--version` argument to properly handle release candidates [[#3283](https://github.com/wp-cli/wp-cli/pull/3283)]. - * Ensures `wp core download --version=latest` produces correcly-versioned cache key [[#3467](https://github.com/wp-cli/wp-cli/pull/3467)]. + * Ensures `wp core download --version=latest` produces correctly-versioned cache key [[#3467](https://github.com/wp-cli/wp-cli/pull/3467)]. * `wp core language update`: * Fixes strict standard error about variable reference [[#3380](https://github.com/wp-cli/wp-cli/pull/3380)]. * Permits updating language packs even when `en_US` is set as locale [[#3397](https://github.com/wp-cli/wp-cli/pull/3397)]. From a99ab8b9d088aac13d425a5f9992c5259071e500 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 12:05:04 -0700 Subject: [PATCH 15/17] Clarify what `` is --- _posts/2016-10-25-version-0.25.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 5ff822c3..79f5e57e 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -41,7 +41,7 @@ The WP-CLI community has been quite active in creating new tools for you to use * [trepmal/wp-revisions-cli](https://github.com/trepmal/wp-revisions-cli) - Manage revisions. * [welaika/wp-cli-db2utf8](https://github.com/welaika/wp-cli-db2utf8) - Downgrade db encoding of a new WP installation to UTF8. -Install any one of these with `wp package install `. When you do, go say thanks to the author! +Install any one of these with `wp package install ` (where `` is typically the `/`). When you do, go say thanks to the author! ### More ways to install WP-CLI packages From cec6ed1f018f7f1bf0547c6c58b303a4cd879cea Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 12:07:34 -0700 Subject: [PATCH 16/17] Newline it --- _posts/2016-10-25-version-0.25.0.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 79f5e57e..2ffb4669 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -4,7 +4,9 @@ author: danielbachhuber title: Version 0.25.0 released --- -Happy release day! Today, I'm excited to bring you WP-CLI v0.25.0. Check out the [newly published roadmap](/docs/roadmap/) for details on upcoming releases and product focus (hint: there's a future where WP-CLI no longer supports PHP 5.3). +Happy release day! + +Today, I'm excited to bring you WP-CLI v0.25.0. Check out the [newly published roadmap](/docs/roadmap/) for details on upcoming releases and product focus (hint: there's a future where WP-CLI no longer supports PHP 5.3). Let's dive in. From de9a5ef55e6bc7a44625790a1c07e7ef6d67e513 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Tue, 25 Oct 2016 12:09:43 -0700 Subject: [PATCH 17/17] Fix grammar --- _posts/2016-10-25-version-0.25.0.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_posts/2016-10-25-version-0.25.0.md b/_posts/2016-10-25-version-0.25.0.md index 2ffb4669..cd1bf6b1 100644 --- a/_posts/2016-10-25-version-0.25.0.md +++ b/_posts/2016-10-25-version-0.25.0.md @@ -22,7 +22,7 @@ Inspect the change in [this pull request](https://github.com/wp-cli/wp-cli/pull/ The WP-CLI community has been quite active in creating new tools for you to use (and contribute back to): -* [aaemnnosttv/wp-cli-login-command](https://github.com/aaemnnosttv/wp-cli-login-command) - Login to WordPress with secure passwordless magic links. +* [aaemnnosttv/wp-cli-login-command](https://github.com/aaemnnosttv/wp-cli-login-command) - Log in to WordPress with secure passwordless magic links. * [alessandrotesoro/wp-cli-helpscout-docs-parser](https://github.com/alessandrotesoro/wp-cli-helpscout-docs-parser) - Extract helpscout docs articles and categories to build an offline documentation. * [alessandrotesoro/wp-usergen-cli](https://github.com/alessandrotesoro/wp-usergen-cli) - Generate random users for testing purposes. * [anhskohbo/wp-cli-themecheck](https://github.com/anhskohbo/wp-cli-themecheck) - Run Themecheck in WP-CLI. @@ -136,7 +136,7 @@ Framework enhancements: * Ignores `url:` in `wp-cli.yml` when alias is used, because aliases completely override user, url, path, ssh, and http [[#3450](https://github.com/wp-cli/wp-cli/pull/3450)]. * Warns when `WP_CLI::launch()` ends up with `return_code=-1`, which could be caused by a custom compiled version of PHP that uses the `--enable-sigchild` option [[#3458](https://github.com/wp-cli/wp-cli/pull/3458)]. * Provides more verbosity in `wp_die()` handler to give the end user more detail when a database connection fails [[#3459](https://github.com/wp-cli/wp-cli/pull/3459)]. -* Support passing arguments to `WP_CLI::do_hook()` [[#3470](https://github.com/wp-cli/wp-cli/pull/3470)]. +* Supports passing arguments to `WP_CLI::do_hook()` [[#3470](https://github.com/wp-cli/wp-cli/pull/3470)]. * Logs the current alias when executing an alias group [[#3471](https://github.com/wp-cli/wp-cli/pull/3471)]. * Only checks `options` for a positional argument when a value is present [[#3481](https://github.com/wp-cli/wp-cli/pull/3481)]. * Variety of bash completion improvements [[#3490](https://github.com/wp-cli/wp-cli/pull/3490), [#3491](https://github.com/wp-cli/wp-cli/pull/3491), [#3492](https://github.com/wp-cli/wp-cli/pull/3492)].