Skip to content

Regenerate README file #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swissspidy merged 1 commit into from
Mar 17, 2026
Merged

Regenerate README file #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ wp widget patch <action> <widget-id> <key-path>... [<value>] [--format=<format>]
Resets sidebar.

~~~
wp widget reset [<sidebar-id>...] [--all]
wp widget reset [<sidebar-id>...] [--all] [--inactive]
~~~

Removes all widgets from the sidebar and places them in Inactive Widgets.
Expand All @@ -277,22 +277,29 @@ Removes all widgets from the sidebar and places them in Inactive Widgets.
[--all]
If set, all sidebars will be reset.

[--inactive]
If set, all inactive sidebars will also be reset, in addition to any sidebars specified via <sidebar-id>... or selected with --all.

**EXAMPLES**

# Reset a sidebar
$ wp widget reset sidebar-1
Success: Sidebar 'sidebar-1' reset.
Sidebar 'sidebar-1' reset.

# Reset multiple sidebars
$ wp widget reset sidebar-1 sidebar-2
Success: Sidebar 'sidebar-1' reset.
Success: Sidebar 'sidebar-2' reset.
Sidebar 'sidebar-1' reset.
Sidebar 'sidebar-2' reset.

# Reset all sidebars
$ wp widget reset --all
Success: Sidebar 'sidebar-1' reset.
Success: Sidebar 'sidebar-2' reset.
Success: Sidebar 'sidebar-3' reset.
Sidebar 'sidebar-1' reset.
Sidebar 'sidebar-2' reset.
Sidebar 'sidebar-3' reset.

# Reset all inactive sidebars
$ wp widget reset --inactive
Sidebar 'old-sidebar-1' reset.



Expand Down Expand Up @@ -401,11 +408,14 @@ wp sidebar get <id> [--fields=<fields>] [--format=<format>]
Lists registered sidebars.

~~~
wp sidebar list [--fields=<fields>] [--format=<format>]
wp sidebar list [--inactive] [--fields=<fields>] [--format=<format>]
~~~

**OPTIONS**

[--inactive]
If set, only inactive sidebars will be listed.

[--fields=<fields>]
Limit the output to specific object fields.

Expand Down Expand Up @@ -445,6 +455,10 @@ These fields are optionally available:
"Widget Area",sidebar-1
"Inactive Widgets",wp_inactive_widgets

$ wp sidebar list --inactive --fields=id --format=csv
id
old-sidebar-1

## Installing

This package is included with WP-CLI itself, no additional installation necessary.
Expand Down