Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions commands/cache/add/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ be added.

[<group>]
: Method for grouping data within the cache which allows the same key to be used across groups.
\---
default: default
\---

[<expiration>]
: Define how long to keep the value, in seconds. `0` means as long as possible.
Expand Down
8 changes: 7 additions & 1 deletion commands/cache/decr/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,16 @@ Errors if the value can't be decremented.
: Cache key.

[<offset>]
: The amount by which to decrement the item's value. Default is 1.
: The amount by which to decrement the item's value.
\---
default: 1
\---

[<group>]
: Method for grouping data within the cache which allows the same key to be used across groups.
\---
default: default
\---

### EXAMPLES

Expand Down
3 changes: 3 additions & 0 deletions commands/cache/delete/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ Errors if the value can't be deleted.

[<group>]
: Method for grouping data within the cache which allows the same key to be used across groups.
\---
default: default
\---

### EXAMPLES

Expand Down
3 changes: 3 additions & 0 deletions commands/cache/get/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ Errors if the value doesn't exist.

[<group>]
: Method for grouping data within the cache which allows the same key to be used across groups.
\---
default: default
___

### EXAMPLES

Expand Down
8 changes: 7 additions & 1 deletion commands/cache/incr/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,16 @@ Errors if the value can't be incremented.
: Cache key.

[<offset>]
: The amount by which to increment the item's value. Default is 1.
: The amount by which to increment the item's value.
\---
default: 1
\---

[<group>]
: Method for grouping data within the cache which allows the same key to be used across groups.
\---
default: default
\---

### EXAMPLES

Expand Down
3 changes: 3 additions & 0 deletions commands/cache/replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ Errors if the value can't be replaced.

[<group>]
: Method for grouping data within the cache which allows the same key to be used across groups.
\---
default: default
\---

[<expiration>]
: Define how long to keep the value, in seconds. `0` means as long as possible.
Expand Down
3 changes: 3 additions & 0 deletions commands/cache/set/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ Errors if the value can't be set.

[<group>]
: Method for grouping data within the cache which allows the same key to be used across groups.
\---
default: default
\---

[<expiration>]
: Define how long to keep the value, in seconds. `0` means as long as possible.
Expand Down
3 changes: 3 additions & 0 deletions commands/core/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ default:
[\--skip-check]
: If set, the database connection is not checked.

[\--force]
: Overwrites existing files, if present.

### EXAMPLES

# Standard wp-config.php file
Expand Down
6 changes: 5 additions & 1 deletion commands/core/update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ display_global_parameters: true

Defaults to updating WordPress to the latest version.

If you see "Error: Another update is currently in progress.", you may
need to run `wp option delete core_updater.lock` after verifying another
update isn't actually running.

### OPTIONS

[<zip>]
Expand All @@ -23,7 +27,7 @@ Defaults to updating WordPress to the latest version.
: Only perform updates for minor releases (e.g. update from WP 4.3 to 4.3.3 instead of 4.4.2).

[\--version=<version>]
: Update to a specific version, instead of to the latest version.
: Update to a specific version, instead of to the latest version. Alternatively accepts 'nightly'.

[\--force]
: Update even when installed WP version is greater than the requested version.
Expand Down
11 changes: 11 additions & 0 deletions commands/db/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ display_global_parameters: true

<hr />

### OPTIONS

[\--database=&lt;database&gt;]
: Use a specific database. Defaults to DB_NAME.

[\--default-character-set=&lt;character-set&gt;]
: Use a specific character set. Defaults to DB_CHARSET when defined.

[\--&lt;field&gt;=&lt;value&gt;]
: Extra arguments to pass to the MySQL executable.

### EXAMPLES

# Open MySQL console
Expand Down
12 changes: 12 additions & 0 deletions commands/db/tables/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,18 @@ options:

### EXAMPLES

# List tables for a single site, without shared tables like 'wp_users'
$ wp db tables --scope=blog --url=sub.example.com
wp_3_posts
wp_3_comments
wp_3_options
wp_3_postmeta
wp_3_terms
wp_3_term_taxonomy
wp_3_term_relationships
wp_3_termmeta
wp_3_commentmeta

# Export only tables for a single site
$ wp db export --tables=$(wp db tables --url=sub.example.com --format=csv)
Success: Exported to wordpress_dbase.sql
Expand Down
9 changes: 9 additions & 0 deletions commands/plugin/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,15 @@ for confirmation.
Plugin installed successfully.
Success: Installed 1 of 1 plugins.

# Update from a remote zip file
$ wp plugin install https://github.com/envato/wp-envato-market/archive/master.zip --force
Downloading install package from https://github.com/envato/wp-envato-market/archive/master.zip
Unpacking the package...
Installing the plugin...
Renamed Github-based project from 'wp-envato-market-master' to 'wp-envato-market'.
Plugin updated successfully
Success: Installed 1 of 1 plugins.

# Forcefully re-install all installed plugins
$ wp plugin install $(wp plugin list --field=name) --force
Installing Akismet (3.1.11)
Expand Down
2 changes: 1 addition & 1 deletion commands/scaffold/plugin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ default: travis
options:
- travis
- circle
- gitlab
- gitlab
\---

[\--activate]
Expand Down
12 changes: 9 additions & 3 deletions commands/search-replace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ You might want to change this depending on your database configuration

[\--skip-columns=&lt;columns&gt;]
: Do not perform the replacement on specific columns. Use commas to
specify multiple columns. 'guid' is skipped by default.
specify multiple columns.

[\--include-columns=&lt;columns&gt;]
: Perform the replacement on specific columns. Use commas to
Expand All @@ -80,8 +80,11 @@ pass --no-recurse-objects to disable.
: Prints rows to the console as they're updated.

[\--regex]
: Runs the search using a regular expression. Warning: search-replace
will take about 15-20x longer when using --regex.
: Runs the search using a regular expression (without delimiters).
Warning: search-replace will take about 15-20x longer when using --regex.

[\--regex-flags=&lt;regex-flags&gt;]
: Pass PCRE modifiers to regex search-replace (e.g. 'i' for case-insensitivity).

### EXAMPLES

Expand All @@ -91,6 +94,9 @@ will take about 15-20x longer when using --regex.
# Run search/replace operation but dont save in database
$ wp search-replace 'foo' 'bar' wp_posts wp_postmeta wp_terms --dry-run

# Run case-insensitive regex search/replace operation (slow)
$ wp search-replace '\[foo id="([0-9]+)"' '[bar id="\1"' --regex --regex-flags='i'

# Turn your production multisite database into a local dev database
$ wp search-replace --url=example.com example.com example.dev 'wp_*options' wp_blogs

Expand Down
3 changes: 2 additions & 1 deletion commands/server/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ default: 8080
\---

[\--docroot=&lt;path&gt;]
: The path to use as the document root.
: The path to use as the document root. If the path global parameter is
set, the default value is it.

[\--config=&lt;file&gt;]
: Configure the server with a specific .ini file.
Expand Down
2 changes: 1 addition & 1 deletion commands/site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ display_global_parameters: true
</tr>
<tr>
<td><a href="/commands/site/option/">option</a></td>
<td>Manage site options.</td>
<td>Manage site options in a multisite install.</td>
</tr>
<tr>
<td><a href="/commands/site/spam/">spam</a></td>
Expand Down
3 changes: 3 additions & 0 deletions commands/site/list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ display_global_parameters: true
: Filter by one or more fields (see "Available Fields" section). However,
'url' isn't an available filter, because it's created from domain + path.

[\--site__in=&lt;value&gt;]
: Only list the sites with these blog_id values (comma-separated).

[\--field=&lt;field&gt;]
: Prints the value of a single field for each site.

Expand Down
2 changes: 1 addition & 1 deletion commands/site/option/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ display_global_parameters: true

<small>[Commands](/commands/) &raquo; [site](/commands/site/) &raquo; option</small>

`wp site option` - Manage site options.
`wp site option` - Manage site options in a multisite install.

<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Asite-option+sort%3Aupdated-desc">Github issues</a></small>

Expand Down
3 changes: 3 additions & 0 deletions commands/site/option/list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ display_global_parameters: true
[\--search=&lt;pattern&gt;]
: Use wildcards ( * and ? ) to match option name.

[\--site_id=&lt;id&gt;]
: Limit options to those of a particular site id.

[\--field=&lt;field&gt;]
: Prints the value of a single field.

Expand Down
13 changes: 10 additions & 3 deletions commands/theme/mod/get/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ display_global_parameters: true
[&lt;mod&gt;...]
: One or more mods to get.

[\--field=&lt;field&gt;]
: Returns the value of a single field.

[\--all]
: List all theme mods

Expand All @@ -33,7 +36,7 @@ options:

### EXAMPLES

# Get all theme mods
# Get all theme mods.
$ wp theme mod get --all
+------------------+---------+
| key | value |
Expand All @@ -43,11 +46,15 @@ options:
| main_text_color | #8224e3 |
+------------------+---------+

# Get single theme mod in JSON format
# Get single theme mod in JSON format.
$ wp theme mod get background_color --format=json
[{"key":"background_color","value":"dd3333"}]

# Get multiple theme mods
# Get value of a single theme mod.
$ wp theme mod get background_color --field=value
dd3333

# Get multiple theme mods.
$ wp theme mod get background_color header_textcolor
+------------------+--------+
| key | value |
Expand Down
2 changes: 1 addition & 1 deletion commands/user/delete/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ make sure to reassign their posts prior to deleting the user.
Success: Removed user 123 from http://example.com

# Delete all contributors and reassign their posts to user 2
$ wp user delete $(wp user list --role=contributor --format=ids) --reassign=2
$ wp user delete $(wp user list --role=contributor --field=ID) --reassign=2
Success: Removed user 813 from http://example.com
Success: Removed user 578 from http://example.com

Expand Down
2 changes: 1 addition & 1 deletion docs/internal-api/wp-cli-colorize/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ settings. Choose from the following tokens (and note 'reset'):
* %U => ['style' => 'underline'],
* %8 => ['style' => 'inverse'],
* %9 => ['style' => 'bright'],
* %_ => ['style' => 'bright')
* %_ => ['style' => 'bright']


*Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.*
Expand Down
9 changes: 5 additions & 4 deletions docs/internal-api/wp-cli-runcommand/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,17 @@ Run a WP-CLI command.

Launch a new child process, or run the command in the current process.
Optionally:

* Prevent halting script execution on error.
* Capture and return STDOUT, or full details about command execution.
* Parse JSON output if the command rendered it.


$options = array(
'return' => true, // Return 'STDOUT'; use 'all' for full object.
'parse' => 'json' // Parse captured STDOUT to JSON array.
'launch' => false, // Reuse the current process.
'exit_error' => true, // Halt script execution on error.
'return' => true, // Return 'STDOUT'; use 'all' for full object.
'parse' => 'json', // Parse captured STDOUT to JSON array.
'launch' => false, // Reuse the current process.
'exit_error' => true, // Halt script execution on error.
);
$plugins = WP_CLI::runcommand( 'plugin list --format=json', $options );

Expand Down
4 changes: 2 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Command line interface for WordPress

For announcements, follow [@wpcli on Twitter](https://twitter.com/wpcli) or [sign up for our email newsletter](http://wp-cli.us13.list-manage.com/subscribe?u=0615e4d18f213891fc000adfd&id=8c61d7641e). [Check out the roadmap](https://wp-cli.org/docs/roadmap/) for an overview of what's planned for upcoming releases.

[![Build Status](https://travis-ci.org/wp-cli/wp-cli.png?branch=master)](https://travis-ci.org/wp-cli/wp-cli) [![Dependency Status](https://gemnasium.com/badges/github.com/wp-cli/wp-cli.svg)](https://gemnasium.com/github.com/wp-cli/wp-cli) [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/wp-cli/wp-cli.svg)](http://isitmaintained.com/project/wp-cli/wp-cli "Average time to resolve an issue") [![Percentage of issues still open](http://isitmaintained.com/badge/open/wp-cli/wp-cli.svg)](http://isitmaintained.com/project/wp-cli/wp-cli "Percentage of issues still open")
[![Build Status](https://travis-ci.org/wp-cli/wp-cli.svg?branch=master)](https://travis-ci.org/wp-cli/wp-cli) [![Dependency Status](https://gemnasium.com/badges/github.com/wp-cli/wp-cli.svg)](https://gemnasium.com/github.com/wp-cli/wp-cli) [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/wp-cli/wp-cli.svg)](http://isitmaintained.com/project/wp-cli/wp-cli "Average time to resolve an issue") [![Percentage of issues still open](http://isitmaintained.com/badge/open/wp-cli/wp-cli.svg)](http://isitmaintained.com/project/wp-cli/wp-cli "Percentage of issues still open")

Quick links: [Using](#using) &#124; [Installing](#installing) &#124; [Support](#support) &#124; [Extending](#extending) &#124; [Contributing](#contributing) &#124; [Credits](#credits)

Expand Down Expand Up @@ -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: 1.0.0
WP-CLI version: 1.1.0
```

### Updating
Expand Down