mirror of
https://gh.wpcy.net/https://github.com/wp-cli/handbook.git
synced 2026-04-29 14:14:51 +08:00
47 lines
2.3 KiB
Markdown
47 lines
2.3 KiB
Markdown
# wp widget add
|
|
|
|
Adds a widget to a sidebar.
|
|
|
|
Creates a new widget entry in the database, and associates it with the sidebar.
|
|
|
|
### OPTIONS
|
|
|
|
<name>
|
|
: Widget name.
|
|
|
|
<sidebar-id>
|
|
: ID for the corresponding sidebar.
|
|
|
|
[<position>]
|
|
: Widget's current position within the sidebar. Defaults to last
|
|
|
|
[\--<field>=<value>]
|
|
: Widget option to add, with its new value
|
|
|
|
### EXAMPLES
|
|
|
|
# Add a new calendar widget to sidebar-1 with title "Calendar"
|
|
$ wp widget add calendar sidebar-1 2 --title="Calendar"
|
|
Success: Added widget to sidebar.
|
|
|
|
### 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. |
|
