Skip to content

Commit 822503e

Browse files
danielbachhuberdanielbachhuber
committed
Regenerate command pages for v1.0.0
1 parent 4dab8ba commit 822503e

205 files changed

Lines changed: 1032 additions & 373 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.

‎_includes/cmd-list.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@
88
</tr>
99
<tr>
1010
<td><a href="/commands/cli/">cli</a></td>
11-
<td>Get information about WP-CLI itself.</td>
11+
<td>Manage WP-CLI itself.</td>
1212
</tr>
1313
<tr>
1414
<td><a href="/commands/comment/">comment</a></td>
1515
<td>Manage comments.</td>
1616
</tr>
1717
<tr>
1818
<td><a href="/commands/core/">core</a></td>
19-
<td>Download, install, update and otherwise manage WordPress proper.</td>
19+
<td>Download, install, update and manage a WordPress install.</td>
2020
</tr>
2121
<tr>
2222
<td><a href="/commands/cron/">cron</a></td>
2323
<td>Manage WP-Cron events and schedules.</td>
2424
</tr>
2525
<tr>
2626
<td><a href="/commands/db/">db</a></td>
27-
<td>Perform basic database operations.</td>
27+
<td>Perform basic database operations using credentials stored in wp-config.php</td>
2828
</tr>
2929
<tr>
3030
<td><a href="/commands/eval/">eval</a></td>
@@ -36,7 +36,7 @@
3636
</tr>
3737
<tr>
3838
<td><a href="/commands/export/">export</a></td>
39-
<td>Export content to a WXR file.</td>
39+
<td>Export WordPress content to a WXR file.</td>
4040
</tr>
4141
<tr>
4242
<td><a href="/commands/help/">help</a></td>
@@ -88,7 +88,7 @@
8888
</tr>
8989
<tr>
9090
<td><a href="/commands/scaffold/">scaffold</a></td>
91-
<td>Generate code for post types, taxonomies, etc.</td>
91+
<td>Generate code for post types, taxonomies, plugins, child themes. etc.</td>
9292
</tr>
9393
<tr>
9494
<td><a href="/commands/search-replace/">search-replace</a></td>
@@ -112,7 +112,7 @@
112112
</tr>
113113
<tr>
114114
<td><a href="/commands/super-admin/">super-admin</a></td>
115-
<td>List, add, and remove super admins from a network.</td>
115+
<td>Manage super admins on WordPress multisite.</td>
116116
</tr>
117117
<tr>
118118
<td><a href="/commands/taxonomy/">taxonomy</a></td>

‎_includes/global-parameters.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ <h3>Global Parameters</h3>
2424
Whether to colorize the output.</p>
2525
<p><code>--debug[=&lt;group&gt;]</code>
2626
Show all PHP errors; add verbosity to WP-CLI bootstrap.</p>
27-
<p><code>--prompt</code>
28-
Prompt the user to enter values for all command arguments.</p>
27+
<p><code>--prompt[=&lt;assoc&gt;]</code>
28+
Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values.</p>
2929
<p><code>--quiet</code>
3030
Suppress informational messages.</p>
3131

‎_includes/internal-api-list.html‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@
5252
<li><strong><a href="/docs/internal-api/wp-cli-error/">WP_CLI::error()</a></strong> - Display error message prefixed with &quot;Error: &quot; and exit script.</li>
5353

5454

55+
<li><strong><a href="/docs/internal-api/wp-cli-halt/">WP_CLI::halt()</a></strong> - Halt script execution with a specific return code.</li>
56+
57+
5558
<li><strong><a href="/docs/internal-api/wp-cli-error-multi-line/">WP_CLI::error_multi_line()</a></strong> - Display a multi-line error message in a red box. Doesn't exit script.</li>
5659

5760

@@ -69,6 +72,12 @@
6972
<li><strong><a href="/docs/internal-api/wp-cli-utils-get-flag-value/">WP_CLI\Utils\get_flag_value()</a></strong> - Return the flag value or, if it's not set, the $default value.</li>
7073

7174

75+
<li><strong><a href="/docs/internal-api/wp-cli-utils-report-batch-operation-results/">WP_CLI\Utils\report_batch_operation_results()</a></strong> - Report the results of the same operation against multiple resources.</li>
76+
77+
78+
<li><strong><a href="/docs/internal-api/wp-cli-utils-parse-str-to-argv/">WP_CLI\Utils\parse_str_to_argv()</a></strong> - Parse a string of command line arguments into an $argv-esqe variable.</li>
79+
80+
7281
<li><strong><a href="/docs/internal-api/wp-cli-confirm/">WP_CLI::confirm()</a></strong> - Ask for confirmation before running a destructive operation.</li>
7382

7483

@@ -92,6 +101,9 @@
92101
<li><strong><a href="/docs/internal-api/wp-cli-launch-self/">WP_CLI::launch_self()</a></strong> - Run a WP-CLI command in a new process reusing the current runtime arguments.</li>
93102

94103

104+
<li><strong><a href="/docs/internal-api/wp-cli-runcommand/">WP_CLI::runcommand()</a></strong> - Run a WP-CLI command.</li>
105+
106+
95107
<li><strong><a href="/docs/internal-api/wp-cli-run-command/">WP_CLI::run_command()</a></strong> - Run a given command within the current process using the same global</li>
96108

97109

‎_includes/param-list.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,12 +156,12 @@
156156
</tr>
157157
<tr>
158158
<td>
159-
Prompt the user to enter values for all command arguments.
159+
Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values.
160160
<br />
161161
Default value: <code>false</code>
162162
</td>
163163
<td>
164-
<code class="flag">--prompt</code>
164+
<code class="flag">--prompt[=&lt;assoc&gt;]</code>
165165
</td>
166166
<td>
167167
<em>Not available as an option</em>

‎commands/cache/add/index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ display_global_parameters: true
1212

1313
<hr />
1414

15-
If a value already exists for the key, the value isn't added.
15+
Errors if a value already exists for the key, which means the value can't
16+
be added.
1617

1718
### OPTIONS
1819

‎commands/cache/decr/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ display_global_parameters: true
1212

1313
<hr />
1414

15+
Errors if the value can't be decremented.
16+
1517
### OPTIONS
1618

1719
&lt;key&gt;

‎commands/cache/delete/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ display_global_parameters: true
1212

1313
<hr />
1414

15+
Errors if the value can't be deleted.
16+
1517
### OPTIONS
1618

1719
&lt;key&gt;

‎commands/cache/flush/index.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ display_global_parameters: true
1212

1313
<hr />
1414

15-
For sites using a persistent object cache, because WordPress Multisite simply adds a blog id
16-
to the cache key, flushing cache is typically a global operation.
15+
For WordPress multisite instances using a persistent object cache,
16+
flushing the object cache will typically flush the cache for all sites.
17+
Beware of the performance impact when flushing the object cache in
18+
production.
19+
20+
Errors if the object cache can't be flushed.
1721

1822
### EXAMPLES
1923

‎commands/cache/get/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ display_global_parameters: true
1212

1313
<hr />
1414

15+
Errors if the value doesn't exist.
16+
1517
### OPTIONS
1618

1719
&lt;key&gt;

‎commands/cache/incr/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ display_global_parameters: true
1212

1313
<hr />
1414

15+
Errors if the value can't be incremented.
16+
1517
### OPTIONS
1618

1719
&lt;key&gt;

0 commit comments

Comments
 (0)