Skip to content

Extend wp sidebar command with additional subcommands #69

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

Closed
iamsohilvahora wants to merge 5 commits into from
Closed

Extend wp sidebar command with additional subcommands #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a0e6d6
Extend wp sidebar command with get, exists, and widgets subcommands
iamsohilvahora Jan 28, 2026
720ded9
Ensure inactive widgets sidebar is registered in wp sidebar subcommands
iamsohilvahora Jan 28, 2026
36aa3e1
fix: exclude wp_inactive_widgets
iamsohilvahora Jan 28, 2026
0e6d9d1
Updated only get and exists function
iamsohilvahora Jan 28, 2026
31910a9
Added feature for testing of the get and exists function
iamsohilvahora Feb 2, 2026
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
18 changes: 18 additions & 0 deletions features/sidebar.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,21 @@ Feature: Manage WordPress sidebars
"""
4
"""

Scenario: Get sidebar details
Given a WP install
When I run `wp sidebar get sidebar-1`
Then STDOUT should contain:
"""
sidebar-1
"""

Scenario: Sidebar exists command returns success
Given a WP install
When I run `wp sidebar exists sidebar-1`
Then the return code should be 0

Scenario: Sidebar exists command returns failure
Given a WP install
When I run `wp sidebar exists does-not-exist`
Then the return code should be 1
70 changes: 70 additions & 0 deletions src/Sidebar_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,74 @@ public function list_( $args, $assoc_args ) {
$formatter = new Formatter( $assoc_args, $this->fields );
$formatter->display_items( $sidebars );
}

/**
* Get details about a specific sidebar.
*
* ## OPTIONS
*
* <id>
* : The sidebar ID.
*
* [--fields=<fields>]
* : Limit the output to specific object fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - json
* - yaml
* ---
*
* ## EXAMPLES
*
* $ wp sidebar get sidebar-1
* $ wp sidebar get wp_inactive_widgets --format=json
*
* @when after_wp_load
*/
public function get( $args, $assoc_args ) {
global $wp_registered_sidebars;

Utils\wp_register_unused_sidebar();

$id = $args[0];

if ( ! isset( $wp_registered_sidebars[ $id ] ) ) {
WP_CLI::error( "Sidebar '{$id}' does not exist." );
}

$formatter = new Formatter( $assoc_args, $this->fields );
$formatter->display_item( $wp_registered_sidebars[ $id ] );
}

/**
* Check if a sidebar exists.
*
* ## OPTIONS
*
* <id>
* : The sidebar ID.
*
* ## EXAMPLES
*
* $ wp sidebar exists sidebar-1
* $ wp sidebar exists wp_inactive_widgets && echo "exists"
*
* @when after_wp_load
*/
public function exists( $args ) {
global $wp_registered_sidebars;

Utils\wp_register_unused_sidebar();

if ( isset( $wp_registered_sidebars[ $args[0] ] ) ) {
WP_CLI::halt( 0 );
}

WP_CLI::halt( 1 );
}
}
Loading