Merge pull request #156 from wp-cli/regen-1-4-0

Regenerate command docs for v1.4.0
wp-cli · Oct 17, 2017 · bc99e1d · bc99e1d
2 parents 898b640 + bca3e97
commit bc99e1d
Show file tree

Hide file tree

Showing 291 changed files with 1,654 additions and 303 deletions.
diff --git a/bin/commands-manifest.json b/bin/commands-manifest.json
@@ -439,6 +439,14 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/cli\/completions.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/wp-cli"
     },
+    "cli\/has-command": {
+        "title": "cli has-command",
+        "slug": "has-command",
+        "cmd_path": "cli\/has-command",
+        "parent": "cli",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/cli\/has-command.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/wp-cli"
+    },
     "cli\/info": {
         "title": "cli info",
         "slug": "info",
@@ -847,6 +855,14 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/core.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/language-command"
     },
+    "media\/image-size": {
+        "title": "media image-size",
+        "slug": "image-size",
+        "cmd_path": "media\/image-size",
+        "parent": "media",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/media\/image-size.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/media-command"
+    },
     "media\/import": {
         "title": "media import",
         "slug": "import",
@@ -943,6 +959,22 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/option\/list.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "option\/patch": {
+        "title": "option patch",
+        "slug": "patch",
+        "cmd_path": "option\/patch",
+        "parent": "option",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/option\/patch.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
+    "option\/pluck": {
+        "title": "option pluck",
+        "slug": "pluck",
+        "cmd_path": "option\/pluck",
+        "parent": "option",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/option\/pluck.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "option\/update": {
         "title": "option update",
         "slug": "update",
@@ -1375,6 +1407,14 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/list.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "site\/mature": {
+        "title": "site mature",
+        "slug": "mature",
+        "cmd_path": "site\/mature",
+        "parent": "site",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/mature.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "site\/option": {
         "title": "site option",
         "slug": "option",
@@ -1383,6 +1423,22 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/option.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "site\/private": {
+        "title": "site private",
+        "slug": "private",
+        "cmd_path": "site\/private",
+        "parent": "site",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/private.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
+    "site\/public": {
+        "title": "site public",
+        "slug": "public",
+        "cmd_path": "site\/public",
+        "parent": "site",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/public.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "site\/spam": {
         "title": "site spam",
         "slug": "spam",
@@ -1399,6 +1455,14 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/unarchive.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "site\/unmature": {
+        "title": "site unmature",
+        "slug": "unmature",
+        "cmd_path": "site\/unmature",
+        "parent": "site",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/unmature.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "site\/unspam": {
         "title": "site unspam",
         "slug": "unspam",
@@ -1759,6 +1823,14 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/user\/set-role.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "user\/spam": {
+        "title": "user spam",
+        "slug": "spam",
+        "cmd_path": "user\/spam",
+        "parent": "user",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/user\/spam.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "user\/term": {
         "title": "user term",
         "slug": "term",
@@ -1767,6 +1839,14 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/user\/term.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "user\/unspam": {
+        "title": "user unspam",
+        "slug": "unspam",
+        "cmd_path": "user\/unspam",
+        "parent": "user",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/user\/unspam.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "user\/update": {
         "title": "user update",
         "slug": "update",
@@ -1863,6 +1943,22 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/comment\/meta\/list.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "comment\/meta\/patch": {
+        "title": "comment meta patch",
+        "slug": "patch",
+        "cmd_path": "comment\/meta\/patch",
+        "parent": "comment\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/comment\/meta\/patch.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
+    "comment\/meta\/pluck": {
+        "title": "comment meta pluck",
+        "slug": "pluck",
+        "cmd_path": "comment\/meta\/pluck",
+        "parent": "comment\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/comment\/meta\/pluck.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "comment\/meta\/update": {
         "title": "comment meta update",
         "slug": "update",
@@ -2055,6 +2151,22 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/network\/meta\/list.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "network\/meta\/patch": {
+        "title": "network meta patch",
+        "slug": "patch",
+        "cmd_path": "network\/meta\/patch",
+        "parent": "network\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/network\/meta\/patch.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
+    "network\/meta\/pluck": {
+        "title": "network meta pluck",
+        "slug": "pluck",
+        "cmd_path": "network\/meta\/pluck",
+        "parent": "network\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/network\/meta\/pluck.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "network\/meta\/update": {
         "title": "network meta update",
         "slug": "update",
@@ -2095,6 +2207,22 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/post\/meta\/list.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "post\/meta\/patch": {
+        "title": "post meta patch",
+        "slug": "patch",
+        "cmd_path": "post\/meta\/patch",
+        "parent": "post\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/post\/meta\/patch.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
+    "post\/meta\/pluck": {
+        "title": "post meta pluck",
+        "slug": "pluck",
+        "cmd_path": "post\/meta\/pluck",
+        "parent": "post\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/post\/meta\/pluck.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "post\/meta\/update": {
         "title": "post meta update",
         "slug": "update",
@@ -2167,6 +2295,22 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/option\/list.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "site\/option\/patch": {
+        "title": "site option patch",
+        "slug": "patch",
+        "cmd_path": "site\/option\/patch",
+        "parent": "site\/option",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/option\/patch.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
+    "site\/option\/pluck": {
+        "title": "site option pluck",
+        "slug": "pluck",
+        "cmd_path": "site\/option\/pluck",
+        "parent": "site\/option",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/option\/pluck.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "site\/option\/update": {
         "title": "site option update",
         "slug": "update",
@@ -2207,6 +2351,22 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/term\/meta\/list.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "term\/meta\/patch": {
+        "title": "term meta patch",
+        "slug": "patch",
+        "cmd_path": "term\/meta\/patch",
+        "parent": "term\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/term\/meta\/patch.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
+    "term\/meta\/pluck": {
+        "title": "term meta pluck",
+        "slug": "pluck",
+        "cmd_path": "term\/meta\/pluck",
+        "parent": "term\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/term\/meta\/pluck.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "term\/meta\/update": {
         "title": "term meta update",
         "slug": "update",
@@ -2271,6 +2431,22 @@
         "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/user\/meta\/list.md",
         "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
     },
+    "user\/meta\/patch": {
+        "title": "user meta patch",
+        "slug": "patch",
+        "cmd_path": "user\/meta\/patch",
+        "parent": "user\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/user\/meta\/patch.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
+    "user\/meta\/pluck": {
+        "title": "user meta pluck",
+        "slug": "pluck",
+        "cmd_path": "user\/meta\/pluck",
+        "parent": "user\/meta",
+        "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/user\/meta\/pluck.md",
+        "repo_url": "https:\/\/github.com\/wp-cli\/entity-command"
+    },
     "user\/meta\/update": {
         "title": "user meta update",
         "slug": "update",

diff --git a/commands/cache.md b/commands/cache.md
@@ -1,8 +1,10 @@
 # wp cache
 
-Manage the object cache.
+Manipulate the WP Object Cache object.
 
-Use a persistent object cache drop-in to persist cache values between requests.
+By default, the WP Object Cache exists in PHP memory for the length of the request (and is emptied at the end). Use a persistent object cache drop-in to persist the object cache between requests.
+
+[Read the codex article](https://codex.wordpress.org/Class_Reference/WP_Object_Cache) for more detail.
 
 ### EXAMPLES
 

diff --git a/commands/cache/add.md b/commands/cache/add.md
@@ -38,7 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
 |:----------------|:-----------------------------|
 | `--path=<path>` | Path to the WordPress files. |
 | `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
-| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker" or "docker-compose"). |
+| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
 | `--http=<http>` | Perform operation against a remote WordPress install over HTTP. |
 | `--user=<id|login|email>` | Set the WordPress user. |
 | `--skip-plugins[=<plugin>]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. |

diff --git a/commands/cache/decr.md b/commands/cache/decr.md
@@ -35,7 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
 |:----------------|:-----------------------------|
 | `--path=<path>` | Path to the WordPress files. |
 | `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
-| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker" or "docker-compose"). |
+| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
 | `--http=<http>` | Perform operation against a remote WordPress install over HTTP. |
 | `--user=<id|login|email>` | Set the WordPress user. |
 | `--skip-plugins[=<plugin>]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. |

diff --git a/commands/cache/delete.md b/commands/cache/delete.md
@@ -29,7 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
 |:----------------|:-----------------------------|
 | `--path=<path>` | Path to the WordPress files. |
 | `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
-| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker" or "docker-compose"). |
+| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
 | `--http=<http>` | Perform operation against a remote WordPress install over HTTP. |
 | `--user=<id|login|email>` | Set the WordPress user. |
 | `--skip-plugins[=<plugin>]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. |

diff --git a/commands/cache/flush.md b/commands/cache/flush.md
@@ -20,7 +20,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
 |:----------------|:-----------------------------|
 | `--path=<path>` | Path to the WordPress files. |
 | `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
-| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker" or "docker-compose"). |
+| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
 | `--http=<http>` | Perform operation against a remote WordPress install over HTTP. |
 | `--user=<id|login|email>` | Set the WordPress user. |
 | `--skip-plugins[=<plugin>]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. |

diff --git a/commands/cache/get.md b/commands/cache/get.md
@@ -13,7 +13,7 @@ Errors if the value doesn't exist.
 : Method for grouping data within the cache which allows the same key to be used across groups.
 \---
 default: default
-___
+\---
 
 ### EXAMPLES
 
@@ -29,7 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
 |:----------------|:-----------------------------|
 | `--path=<path>` | Path to the WordPress files. |
 | `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
-| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker" or "docker-compose"). |
+| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
 | `--http=<http>` | Perform operation against a remote WordPress install over HTTP. |
 | `--user=<id|login|email>` | Set the WordPress user. |
 | `--skip-plugins[=<plugin>]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. |

diff --git a/commands/cache/incr.md b/commands/cache/incr.md
@@ -35,7 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
 |:----------------|:-----------------------------|
 | `--path=<path>` | Path to the WordPress files. |
 | `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
-| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker" or "docker-compose"). |
+| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
 | `--http=<http>` | Perform operation against a remote WordPress install over HTTP. |
 | `--user=<id|login|email>` | Set the WordPress user. |
 | `--skip-plugins[=<plugin>]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. |

diff --git a/commands/cache/replace.md b/commands/cache/replace.md
@@ -38,7 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
 |:----------------|:-----------------------------|
 | `--path=<path>` | Path to the WordPress files. |
 | `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
-| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker" or "docker-compose"). |
+| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
 | `--http=<http>` | Perform operation against a remote WordPress install over HTTP. |
 | `--user=<id|login|email>` | Set the WordPress user. |
 | `--skip-plugins[=<plugin>]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. |

diff --git a/commands/cache/set.md b/commands/cache/set.md
@@ -38,7 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
 |:----------------|:-----------------------------|
 | `--path=<path>` | Path to the WordPress files. |
 | `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
-| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker" or "docker-compose"). |
+| `--ssh=[<scheme>:][<user>@]<host|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). |
 | `--http=<http>` | Perform operation against a remote WordPress install over HTTP. |
 | `--user=<id|login|email>` | Set the WordPress user. |
 | `--skip-plugins[=<plugin>]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. |