handbook/commands/widget/patch.md

wp widget patch

Updates a nested value in a widget's options.

OPTIONS

See the argument syntax reference for a detailed explanation of the syntax conventions used.

<action>

Patch action to perform. --- options:

• insert
• update
• delete ---

<widget-id>

Unique ID for the widget.

<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.

[--format=<format>]

The serialization format for the value. --- default: plaintext options:

• plaintext
• json ---

EXAMPLES

# Update a nested value in the options of the archives-1 widget
$ wp widget patch update archives-1 title "My Archives"
Success: Widget updated.

# Insert a new nested value into the options of the archives-1 widget
$ wp widget patch insert archives-1 new_key "New Value"
Success: Widget updated.

# Delete a nested value from the options of the archives-1 widget
$ wp widget patch delete archives-1 title
Success: Widget updated.

GLOBAL PARAMETERS

These global parameters 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").
--ssh-args=<args>	Pass additional arguments to SSH (or other tools specified by --ssh scheme).
--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.
--alias=<name>	Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file.
--assume-https	Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer.