cwp widgets pull
shipped 1.0.0cwp widgets pull [env] [flags]This name is an alias. The work moved to cwp pull --only widgets, and that page documents it. This spelling still runs for one minor cycle.
Acts on the local site. Name an environment to act there instead.
| Argument | What it is | Default |
|---|---|---|
[env] | environment to read (default: default_environment in cwp.yml) |
| Flag | What it does | Default |
|---|---|---|
--with-agent | with —dry-run on a host with no shell: install and remove the PHP agent so the plan is real | off |
Plus the shared flags --json, -v, --verbose, -q, --quiet and --dry-run.
What it does
Reads the declared widget areas from a site into the tree, one file per area at
widgets/<area>.yml.
A widget pointing at a menu carries the menu’s identity rather than its term
id. A menu entry’s target and a post-reference option use the same reference
shape.
The pull reports an area named in cwp.yml that this theme does not register
and does not invent it.
What it does not do
- It does not write when nothing changed.
- It carries no area you did not declare, and never
wp_inactive_widgets. WordPress’s holding pen for widgets removed from an area is not an area anybody assembled.