is_registered_sidebar()WP 4.4.0

Checks if a sidebar is registered.

1 time — 0.000013 sec (very fast) | 50000 times — 0.02 sec (speed of light)

No Hooks.

Return

true|false. True if the sidebar is registered, false otherwise.

Usage

is_registered_sidebar( $sidebar_id );
$sidebar_id(string|int) (required)
The ID of the sidebar when it was registered.

Examples

0

#1 Check if the 'sidebar' widget panel is already there and register it if not.

add_action( 'widgets_init', 'register_my_widgets' );

function register_my_widgets(){

	if( is_registered_sidebar( 'sidebar' ) ){
		return;
	}

	register_sidebar( [
		'name'         => 'website sidebar',
		'id'           => 'sidebar',
		'description'  => 'These widgets will be shown in the sidebar of the site',
		'before_title' => '<h1>',
		'after_title'  => '</h1>'
	] );
}

Notes

  • Global. Array. $wp_registered_sidebars Registered sidebars.

Changelog

Since 4.4.0 Introduced.

Code of is_registered_sidebar() WP 6.0

function is_registered_sidebar( $sidebar_id ) {
	global $wp_registered_sidebars;

	return isset( $wp_registered_sidebars[ $sidebar_id ] );
}