Skip to content

Commit 14f76b0

Browse files
authored
Merge pull request #105 from wp-cli/regenerate-readme
Regenerate README file
2 parents 1d789af + ab201a2 commit 14f76b0

File tree

1 file changed

+222
-57
lines changed

1 file changed

+222
-57
lines changed

README.md

Lines changed: 222 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,91 @@ Errors if the value can't be incremented.
249249

250250

251251

252+
### wp cache patch
253+
254+
Update a nested value from the cache.
255+
256+
~~~
257+
wp cache patch <action> <key> <key-path>... [<value>] [--group=<group>] [--format=<format>]
258+
~~~
259+
260+
**OPTIONS**
261+
262+
<action>
263+
Patch action to perform.
264+
---
265+
options:
266+
- insert
267+
- update
268+
- delete
269+
---
270+
271+
<key>
272+
Cache key.
273+
274+
<key-path>...
275+
The name(s) of the keys within the value to locate the value to patch.
276+
277+
[<value>]
278+
The new value. If omitted, the value is read from STDIN.
279+
280+
[--group=<group>]
281+
Method for grouping data within the cache which allows the same key to be used across groups.
282+
---
283+
default: default
284+
---
285+
286+
[--expiration=<expiration>]
287+
: Define how long to keep the value, in seconds. `0` means as long as possible.
288+
---
289+
default: 0
290+
---
291+
292+
[--format=<format>]
293+
The serialization format for the value.
294+
---
295+
default: plaintext
296+
options:
297+
- plaintext
298+
- json
299+
---
300+
301+
302+
303+
### wp cache pluck
304+
305+
Get a nested value from the cache.
306+
307+
~~~
308+
wp cache pluck <key> <key-path>... [--group=<group>] [--format=<format>]
309+
~~~
310+
311+
**OPTIONS**
312+
313+
<key>
314+
Cache key.
315+
316+
<key-path>...
317+
The name(s) of the keys within the value to locate the value to pluck.
318+
319+
[--group=<group>]
320+
Method for grouping data within the cache which allows the same key to be used across groups.
321+
---
322+
default: default
323+
---
324+
325+
[--format=<format>]
326+
The output format of the value.
327+
---
328+
default: plaintext
329+
options:
330+
- plaintext
331+
- json
332+
- yaml
333+
---
334+
335+
336+
252337
### wp cache replace
253338

254339
Replaces a value in the object cache, if the value already exists.
@@ -510,63 +595,6 @@ network|site cache, please see docs for `wp transient`.
510595

511596

512597

513-
### wp transient set
514-
515-
Sets a transient value.
516-
517-
~~~
518-
wp transient set <key> <value> [<expiration>] [--network]
519-
~~~
520-
521-
`<expiration>` is the time until expiration, in seconds.
522-
523-
For a more complete explanation of the transient cache, including the
524-
network|site cache, please see docs for `wp transient`.
525-
526-
**OPTIONS**
527-
528-
<key>
529-
Key for the transient.
530-
531-
<value>
532-
Value to be set for the transient.
533-
534-
[<expiration>]
535-
Time until expiration, in seconds.
536-
537-
[--network]
538-
Set the value of a network|site transient. On single site, this is
539-
is a specially-named cache key. On multisite, this is a global cache
540-
(instead of local to the site).
541-
542-
**EXAMPLES**
543-
544-
$ wp transient set sample_key "test data" 3600
545-
Success: Transient added.
546-
547-
548-
549-
### wp transient type
550-
551-
Determines the type of transients implementation.
552-
553-
~~~
554-
wp transient type
555-
~~~
556-
557-
Indicates whether the transients API is using an object cache or the
558-
database.
559-
560-
For a more complete explanation of the transient cache, including the
561-
network|site cache, please see docs for `wp transient`.
562-
563-
**EXAMPLES**
564-
565-
$ wp transient type
566-
Transients are saved to the database.
567-
568-
569-
570598
### wp transient list
571599

572600
Lists transients and their values.
@@ -630,6 +658,143 @@ This field will be displayed by default for each matching option:
630658
| foo4 | bar4 | 4 hours |
631659
+------+-------+---------------+
632660

661+
662+
663+
### wp transient patch
664+
665+
Update a nested value from a transient.
666+
667+
~~~
668+
wp transient patch <action> <key> <key-path>... [<value>] [--format=<format>] [--expiration=<expiration>] [--network]
669+
~~~
670+
671+
**OPTIONS**
672+
673+
<action>
674+
Patch action to perform.
675+
---
676+
options:
677+
- insert
678+
- update
679+
- delete
680+
---
681+
682+
<key>
683+
Key for the transient.
684+
685+
<key-path>...
686+
The name(s) of the keys within the value to locate the value to patch.
687+
688+
[<value>]
689+
The new value. If omitted, the value is read from STDIN.
690+
691+
[--format=<format>]
692+
The serialization format for the value.
693+
---
694+
default: plaintext
695+
options:
696+
- plaintext
697+
- json
698+
---
699+
700+
[--expiration=<expiration>]
701+
Time until expiration, in seconds.
702+
703+
[--network]
704+
Get the value of a network|site transient. On single site, this is
705+
a specially-named cache key. On multisite, this is a global cache
706+
(instead of local to the site).
707+
708+
709+
710+
### wp transient pluck
711+
712+
Get a nested value from a transient.
713+
714+
~~~
715+
wp transient pluck <key> <key-path>... [--format=<format>] [--network]
716+
~~~
717+
718+
**OPTIONS**
719+
720+
<key>
721+
Key for the transient.
722+
723+
<key-path>...
724+
The name(s) of the keys within the value to locate the value to pluck.
725+
726+
[--format=<format>]
727+
The output format of the value.
728+
---
729+
default: plaintext
730+
options:
731+
- plaintext
732+
- json
733+
- yaml
734+
---
735+
736+
[--network]
737+
Get the value of a network|site transient. On single site, this is
738+
a specially-named cache key. On multisite, this is a global cache
739+
(instead of local to the site).
740+
741+
742+
743+
### wp transient set
744+
745+
Sets a transient value.
746+
747+
~~~
748+
wp transient set <key> <value> [<expiration>] [--network]
749+
~~~
750+
751+
`<expiration>` is the time until expiration, in seconds.
752+
753+
For a more complete explanation of the transient cache, including the
754+
network|site cache, please see docs for `wp transient`.
755+
756+
**OPTIONS**
757+
758+
<key>
759+
Key for the transient.
760+
761+
<value>
762+
Value to be set for the transient.
763+
764+
[<expiration>]
765+
Time until expiration, in seconds.
766+
767+
[--network]
768+
Set the value of a network|site transient. On single site, this is
769+
is a specially-named cache key. On multisite, this is a global cache
770+
(instead of local to the site).
771+
772+
**EXAMPLES**
773+
774+
$ wp transient set sample_key "test data" 3600
775+
Success: Transient added.
776+
777+
778+
779+
### wp transient type
780+
781+
Determines the type of transients implementation.
782+
783+
~~~
784+
wp transient type
785+
~~~
786+
787+
Indicates whether the transients API is using an object cache or the
788+
database.
789+
790+
For a more complete explanation of the transient cache, including the
791+
network|site cache, please see docs for `wp transient`.
792+
793+
**EXAMPLES**
794+
795+
$ wp transient type
796+
Transients are saved to the database.
797+
633798
## Installing
634799

635800
This package is included with WP-CLI itself, no additional installation necessary.

0 commit comments

Comments
 (0)