Skip to content

Commit 653f20e

Browse files
Regen docs for v0.24.0
1 parent 23631f9 commit 653f20e

File tree

211 files changed

+2355
-408
lines changed

Some content is hidden

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

211 files changed

+2355
-408
lines changed

_includes/global-parameters.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ <h3>Global Parameters</h3>
44

55
<p><code>--path=&lt;path&gt;</code>
66
Path to the WordPress files.</p>
7+
<p><code>--ssh=&lt;ssh&gt;</code>
8+
Perform operation against a remote server over SSH.</p>
9+
<p><code>--http=&lt;http&gt;</code>
10+
Perform operation against a remote WordPress install over HTTP.</p>
711
<p><code>--url=&lt;url&gt;</code>
812
Pretend request came from given URL. In multisite, this argument is how the target site is specified.</p>
913
<p><code>--user=&lt;id|login|email&gt;</code>
@@ -18,7 +22,7 @@ <h3>Global Parameters</h3>
1822
Load PHP file before running the command (may be used more than once).</p>
1923
<p><code>--[no-]color</code>
2024
Whether to colorize the output.</p>
21-
<p><code>--debug</code>
25+
<p><code>--debug[=&lt;group&gt;]</code>
2226
Show all PHP errors; add verbosity to WP-CLI bootstrap.</p>
2327
<p><code>--prompt</code>
2428
Prompt the user to enter values for all command arguments.</p>

_includes/param-list.html

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,32 @@
1111
<code class="flag">--path=&lt;path&gt;</code>
1212
</td>
1313
</tr>
14+
<tr>
15+
<td>
16+
Perform operation against a remote server over SSH.
17+
<br />
18+
Default value: <code>null</code>
19+
</td>
20+
<td>
21+
<code class="option">ssh: &lt;ssh&gt;</code>
22+
</td>
23+
<td>
24+
<code class="flag">--ssh=&lt;ssh&gt;</code>
25+
</td>
26+
</tr>
27+
<tr>
28+
<td>
29+
Perform operation against a remote WordPress install over HTTP.
30+
<br />
31+
Default value: <code>null</code>
32+
</td>
33+
<td>
34+
<code class="option">http: &lt;http&gt;</code>
35+
</td>
36+
<td>
37+
<code class="flag">--http=&lt;http&gt;</code>
38+
</td>
39+
</tr>
1440
<tr>
1541
<td>
1642
Pretend request came from given URL. In multisite, this argument is how the target site is specified.
@@ -122,10 +148,10 @@
122148
Default value: <code>false</code>
123149
</td>
124150
<td>
125-
<code class="option">debug: &lt;bool&gt;</code>
151+
<code class="option">debug: &lt;group&gt;</code>
126152
</td>
127153
<td>
128-
<code class="flag">--debug</code>
154+
<code class="flag">--debug[=&lt;group&gt;]</code>
129155
</td>
130156
</tr>
131157
<tr>

commands/cache/add/index.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,16 @@ If a value already exists for the key, the value isn't added.
2424
: Method for grouping data within the cache which allows the same key to be used across groups.
2525

2626
[&lt;expiration&gt;]
27-
: Define how long to keep the value, in seconds. Defaults to 0 (as long as possible).
27+
: Define how long to keep the value, in seconds. `0` means as long as possible.
28+
\---
29+
default: 0
30+
\---
31+
32+
### EXAMPLES
33+
34+
# Add cache.
35+
$ wp cache add my_key my_group my_value 300
36+
Success: Added object 'my_key' in group 'my_value'.
2837

2938

3039

commands/cache/decr/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,11 @@ display_global_parameters: true
2121
[&lt;group&gt;]
2222
: Method for grouping data within the cache which allows the same key to be used across groups.
2323

24+
### EXAMPLES
25+
26+
# Decrease cache value.
27+
$ wp cache decr my_key 2 my_group
28+
48
29+
2430

2531

commands/cache/delete/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,11 @@ display_global_parameters: true
1818
[&lt;group&gt;]
1919
: Method for grouping data within the cache which allows the same key to be used across groups.
2020

21+
### EXAMPLES
22+
23+
# Delete cache.
24+
$ wp cache delete my_key my_group
25+
Success: Object deleted.
26+
2127

2228

commands/cache/flush/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,11 @@ display_global_parameters: true
1313
For sites using a persistent object cache, because WordPress Multisite simply adds a blog id
1414
to the cache key, flushing cache is typically a global operation.
1515

16+
### EXAMPLES
17+
18+
# Flush cache.
19+
$ wp cache flush
20+
Success: The cache was flushed.
21+
1622

1723

commands/cache/get/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,11 @@ display_global_parameters: true
1818
[&lt;group&gt;]
1919
: Method for grouping data within the cache which allows the same key to be used across groups.
2020

21+
### EXAMPLES
22+
23+
# Get cache.
24+
$ wp cache get my_key my_group
25+
my_value
26+
2127

2228

commands/cache/incr/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,11 @@ display_global_parameters: true
2121
[&lt;group&gt;]
2222
: Method for grouping data within the cache which allows the same key to be used across groups.
2323

24+
### EXAMPLES
25+
26+
# Increase cache value.
27+
$ wp cache incr my_key 2 my_group
28+
50
29+
2430

2531

commands/cache/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,17 @@ display_global_parameters: true
1010

1111
<hr />
1212

13+
Note: Persistent Object Caching is needed for these commands.
14+
1315
### EXAMPLES
1416

15-
wp cache set my_key my_value my_group 300
17+
# Set cache.
18+
$ wp cache set my_key my_value my_group 300
19+
Success: Set object 'my_key' in group 'my_group'.
1620

17-
wp cache get my_key my_group
21+
# Get cache.
22+
$ wp cache get my_key my_group
23+
my_value
1824

1925

2026

commands/cache/replace/index.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,16 @@ display_global_parameters: true
2222
: Method for grouping data within the cache which allows the same key to be used across groups.
2323

2424
[&lt;expiration&gt;]
25-
: Define how long to keep the value, in seconds. Defaults to 0 (as long as possible).
25+
: Define how long to keep the value, in seconds. `0` means as long as possible.
26+
\---
27+
default: 0
28+
\---
29+
30+
### EXAMPLES
31+
32+
# Replace cache.
33+
$ wp cache replace my_key new_value my_group
34+
Success: Replaced object 'my_key' in group 'my_group'.
2635

2736

2837

0 commit comments

Comments
 (0)