A command line interface for WordPress

Commands » widget

wp widget - Manage sidebar widgets.

Quick links: Github issues


# List widgets on a given sidebar
$ wp widget list sidebar-1
| name     | id         | position | options              |
| meta     | meta-6     | 1        | {"title":"Meta"}     |
| calendar | calendar-2 | 2        | {"title":"Calendar"} |

# Add a calendar widget to the second position on the sidebar
$ wp widget add calendar sidebar-1 2
Success: Added widget to sidebar.

# Update option(s) associated with a given widget
$ wp widget update calendar-1 --title="Calendar"
Success: Widget updated.

# Delete one or more widgets entirely
$ wp widget delete calendar-2 archive-1
Success: 2 widgets removed from sidebar.


Name Description
add Add a widget to a sidebar.
deactivate Deactivate one or more widgets from an active sidebar.
delete Delete one or more widgets from a sidebar.
list List widgets associated with a sidebar.
move Move the position of a widget.
reset Reset sidebar.
update Update options for an existing widget.