Skip to content

Commit e01cbb1

Browse files
github-actions[bot]github-actions[bot]
authored
Update handbook (#667)
1 parent 823baff commit e01cbb1

574 files changed

Lines changed: 7412 additions & 231 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎bin/commands-manifest.json‎

Lines changed: 584 additions & 0 deletions
Large diffs are not rendered by default.

‎bin/handbook-manifest.json‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -216,15 +216,15 @@
216216
"parent": "behat-steps"
217217
},
218218
"given-a-wp-installation": {
219-
"title": "Given a WP install(ation)",
219+
"title": "Given \/^a WP( \\d[^\\s]+)? install(?:ation)?$\/",
220220
"slug": "given-a-wp-installation",
221221
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation.md",
222222
"parent": "behat-steps"
223223
},
224-
"given-a-wp-installation-in-subdir": {
225-
"title": "Given a WP install(ation) in :subdir",
226-
"slug": "given-a-wp-installation-in-subdir",
227-
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation-in-subdir.md",
224+
"given-a-wp-installation-in": {
225+
"title": "Given \/^a WP( [^\\s]+)? install(?:ation)? in ['"]?([^'"]+)['"]?$\/",
226+
"slug": "given-a-wp-installation-in",
227+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation-in.md",
228228
"parent": "behat-steps"
229229
},
230230
"given-a-wp-installation-with-composer": {
@@ -264,7 +264,7 @@
264264
"parent": "behat-steps"
265265
},
266266
"given-an-file-cache-file": {
267-
"title": "Given \/^an? ([^\\s]+) (file|cache file):$\/",
267+
"title": "Given \/^an? ("[^"]+"|[^\\s]+) (file|cache file):$\/",
268268
"slug": "given-an-file-cache-file",
269269
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-an-file-cache-file.md",
270270
"parent": "behat-steps"
@@ -821,6 +821,12 @@
821821
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-http-request.md",
822822
"parent": "internal-api"
823823
},
824+
"wp-cli-utils-is-stream": {
825+
"title": "WP_CLI\\Utils\\is_stream()",
826+
"slug": "wp-cli-utils-is-stream",
827+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-is-stream.md",
828+
"parent": "internal-api"
829+
},
824830
"wp-cli-utils-ispiped": {
825831
"title": "WP_CLI\\Utils\\isPiped()",
826832
"slug": "wp-cli-utils-ispiped",
@@ -839,6 +845,18 @@
839845
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-make-progress-bar.md",
840846
"parent": "internal-api"
841847
},
848+
"wp-cli-utils-make-temp-dir": {
849+
"title": "WP_CLI\\Utils\\make_temp_dir()",
850+
"slug": "wp-cli-utils-make-temp-dir",
851+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-make-temp-dir.md",
852+
"parent": "internal-api"
853+
},
854+
"wp-cli-utils-make-temp-file": {
855+
"title": "WP_CLI\\Utils\\make_temp_file()",
856+
"slug": "wp-cli-utils-make-temp-file",
857+
"markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-make-temp-file.md",
858+
"parent": "internal-api"
859+
},
842860
"wp-cli-utils-normalize-path": {
843861
"title": "WP_CLI\\Utils\\normalize_path()",
844862
"slug": "wp-cli-utils-normalize-path",

‎commands/ability/can-run.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
4343
| `--path=<path>` | Path to the WordPress files. |
4444
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
4545
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
46+
| `--ssh-args=<args>` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). |
4647
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
4748
| `--user=<id\|login\|email>` | Set the WordPress user. |
4849
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
@@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
5556
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
5657
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
5758
| `--quiet` | Suppress informational messages. |
59+
| `--alias=<name>` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. |
60+
| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. |

‎commands/ability/category/exists.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
3737
| `--path=<path>` | Path to the WordPress files. |
3838
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
3939
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
40+
| `--ssh-args=<args>` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). |
4041
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
4142
| `--user=<id\|login\|email>` | Set the WordPress user. |
4243
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
@@ -49,3 +50,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
4950
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
5051
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
5152
| `--quiet` | Suppress informational messages. |
53+
| `--alias=<name>` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. |
54+
| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. |

‎commands/ability/category/get.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
6363
| `--path=<path>` | Path to the WordPress files. |
6464
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
6565
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
66+
| `--ssh-args=<args>` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). |
6667
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
6768
| `--user=<id\|login\|email>` | Set the WordPress user. |
6869
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
@@ -75,3 +76,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
7576
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
7677
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
7778
| `--quiet` | Suppress informational messages. |
79+
| `--alias=<name>` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. |
80+
| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. |

‎commands/ability/category/list.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
6161
| `--path=<path>` | Path to the WordPress files. |
6262
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
6363
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
64+
| `--ssh-args=<args>` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). |
6465
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
6566
| `--user=<id\|login\|email>` | Set the WordPress user. |
6667
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
@@ -73,3 +74,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
7374
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
7475
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
7576
| `--quiet` | Suppress informational messages. |
77+
| `--alias=<name>` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. |
78+
| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. |

‎commands/ability/exists.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
3737
| `--path=<path>` | Path to the WordPress files. |
3838
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
3939
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
40+
| `--ssh-args=<args>` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). |
4041
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
4142
| `--user=<id\|login\|email>` | Set the WordPress user. |
4243
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
@@ -49,3 +50,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
4950
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
5051
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
5152
| `--quiet` | Suppress informational messages. |
53+
| `--alias=<name>` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. |
54+
| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. |

‎commands/ability/get.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
7474
| `--path=<path>` | Path to the WordPress files. |
7575
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
7676
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
77+
| `--ssh-args=<args>` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). |
7778
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
7879
| `--user=<id\|login\|email>` | Set the WordPress user. |
7980
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
@@ -86,3 +87,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
8687
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
8788
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
8889
| `--quiet` | Suppress informational messages. |
90+
| `--alias=<name>` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. |
91+
| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. |

‎commands/ability/list.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
8888
| `--path=<path>` | Path to the WordPress files. |
8989
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
9090
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
91+
| `--ssh-args=<args>` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). |
9192
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
9293
| `--user=<id\|login\|email>` | Set the WordPress user. |
9394
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
@@ -100,3 +101,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
100101
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
101102
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
102103
| `--quiet` | Suppress informational messages. |
104+
| `--alias=<name>` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. |
105+
| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. |

‎commands/ability/run.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
6464
| `--path=<path>` | Path to the WordPress files. |
6565
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
6666
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
67+
| `--ssh-args=<args>` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). |
6768
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
6869
| `--user=<id\|login\|email>` | Set the WordPress user. |
6970
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
@@ -76,3 +77,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have
7677
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
7778
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
7879
| `--quiet` | Suppress informational messages. |
80+
| `--alias=<name>` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. |
81+
| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. |

0 commit comments

Comments
 (0)