handbook/commands/cache/patch.md
2025-05-13 10:01:47 +02:00

66 lines
2.5 KiB
Markdown

# wp cache patch
Update a nested value from the cache.
### OPTIONS
<action>
: Patch action to perform.
\---
options:
- insert
- update
- delete
\---
<key>
: Cache key.
<key-path>...
: The name(s) of the keys within the value to locate the value to patch.
[<value>]
: The new value. If omitted, the value is read from STDIN.
[\--group=<group>]
: Method for grouping data within the cache which allows the same key to be used across groups.
\---
default: default
\---
[\--expiration=<expiration>]
: Define how long to keep the value, in seconds. `0` means as long as possible.
---
default: 0
---
[\--format=<format>]
: The serialization format for the value.
\---
default: plaintext
options:
- plaintext
- json
\---
### GLOBAL PARAMETERS
These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
| **Argument** | **Description** |
|:----------------|:-----------------------------|
| `--path=<path>` | Path to the WordPress files. |
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
| `--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"). |
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
| `--user=<id\|login\|email>` | Set the WordPress user. |
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
| `--skip-themes[=<themes>]` | Skip loading all themes, or a comma-separated list of themes. |
| `--skip-packages` | Skip loading all installed packages. |
| `--require=<path>` | Load PHP file before running the command (may be used more than once). |
| `--exec=<php-code>` | Execute PHP code before running the command (may be used more than once). |
| `--context=<context>` | Load WordPress in a given context. |
| `--[no-]color` | Whether to colorize the output. |
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
| `--quiet` | Suppress informational messages. |