From ab201a2d57fa8e78d0ae935f26aebf1aca1c91b4 Mon Sep 17 00:00:00 2001 From: Alain Schlesser Date: Mon, 5 May 2025 22:14:58 +0000 Subject: [PATCH] Regenerate README file - 2025-05-05 --- README.md | 279 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 222 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index 3727e14b..c95a42eb 100644 --- a/README.md +++ b/README.md @@ -249,6 +249,91 @@ Errors if the value can't be incremented. +### wp cache patch + +Update a nested value from the cache. + +~~~ +wp cache patch ... [] [--group=] [--format=] +~~~ + +**OPTIONS** + + + Patch action to perform. + --- + options: + - insert + - update + - delete + --- + + + Cache key. + + ... + The name(s) of the keys within the value to locate the value to patch. + + [] + The new value. If omitted, the value is read from STDIN. + + [--group=] + Method for grouping data within the cache which allows the same key to be used across groups. + --- + default: default + --- + +[--expiration=] + : Define how long to keep the value, in seconds. `0` means as long as possible. + --- + default: 0 + --- + + [--format=] + The serialization format for the value. + --- + default: plaintext + options: + - plaintext + - json + --- + + + +### wp cache pluck + +Get a nested value from the cache. + +~~~ +wp cache pluck ... [--group=] [--format=] +~~~ + +**OPTIONS** + + + Cache key. + + ... + The name(s) of the keys within the value to locate the value to pluck. + + [--group=] + Method for grouping data within the cache which allows the same key to be used across groups. + --- + default: default + --- + + [--format=] + The output format of the value. + --- + default: plaintext + options: + - plaintext + - json + - yaml + --- + + + ### wp cache replace 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`. -### wp transient set - -Sets a transient value. - -~~~ -wp transient set [] [--network] -~~~ - -`` is the time until expiration, in seconds. - -For a more complete explanation of the transient cache, including the -network|site cache, please see docs for `wp transient`. - -**OPTIONS** - - - Key for the transient. - - - Value to be set for the transient. - - [] - Time until expiration, in seconds. - - [--network] - Set the value of a network|site transient. On single site, this is - is a specially-named cache key. On multisite, this is a global cache - (instead of local to the site). - -**EXAMPLES** - - $ wp transient set sample_key "test data" 3600 - Success: Transient added. - - - -### wp transient type - -Determines the type of transients implementation. - -~~~ -wp transient type -~~~ - -Indicates whether the transients API is using an object cache or the -database. - -For a more complete explanation of the transient cache, including the -network|site cache, please see docs for `wp transient`. - -**EXAMPLES** - - $ wp transient type - Transients are saved to the database. - - - ### wp transient list Lists transients and their values. @@ -630,6 +658,143 @@ This field will be displayed by default for each matching option: | foo4 | bar4 | 4 hours | +------+-------+---------------+ + + +### wp transient patch + +Update a nested value from a transient. + +~~~ +wp transient patch ... [] [--format=] [--expiration=] [--network] +~~~ + +**OPTIONS** + + + Patch action to perform. + --- + options: + - insert + - update + - delete + --- + + + Key for the transient. + + ... + The name(s) of the keys within the value to locate the value to patch. + + [] + The new value. If omitted, the value is read from STDIN. + + [--format=] + The serialization format for the value. + --- + default: plaintext + options: + - plaintext + - json + --- + + [--expiration=] + Time until expiration, in seconds. + + [--network] + Get the value of a network|site transient. On single site, this is + a specially-named cache key. On multisite, this is a global cache + (instead of local to the site). + + + +### wp transient pluck + +Get a nested value from a transient. + +~~~ +wp transient pluck ... [--format=] [--network] +~~~ + +**OPTIONS** + + + Key for the transient. + + ... + The name(s) of the keys within the value to locate the value to pluck. + + [--format=] + The output format of the value. + --- + default: plaintext + options: + - plaintext + - json + - yaml + --- + + [--network] + Get the value of a network|site transient. On single site, this is + a specially-named cache key. On multisite, this is a global cache + (instead of local to the site). + + + +### wp transient set + +Sets a transient value. + +~~~ +wp transient set [] [--network] +~~~ + +`` is the time until expiration, in seconds. + +For a more complete explanation of the transient cache, including the +network|site cache, please see docs for `wp transient`. + +**OPTIONS** + + + Key for the transient. + + + Value to be set for the transient. + + [] + Time until expiration, in seconds. + + [--network] + Set the value of a network|site transient. On single site, this is + is a specially-named cache key. On multisite, this is a global cache + (instead of local to the site). + +**EXAMPLES** + + $ wp transient set sample_key "test data" 3600 + Success: Transient added. + + + +### wp transient type + +Determines the type of transients implementation. + +~~~ +wp transient type +~~~ + +Indicates whether the transients API is using an object cache or the +database. + +For a more complete explanation of the transient cache, including the +network|site cache, please see docs for `wp transient`. + +**EXAMPLES** + + $ wp transient type + Transients are saved to the database. + ## Installing This package is included with WP-CLI itself, no additional installation necessary.