wp_get_sidebars_widgets() │ WP 2.2.0

Gets a list of all sidebars (widget panels) and a list of all widgets in those sidebars.

Uses global variables $_wp_sidebars_widgets, $sidebars_widgets
Uses the option sidebars_widgets

Internal function — this function is designed to be used by the kernel itself. It is not recommended to use this function in your code.

Used By: is_active_widget(), is_active_sidebar()

1 time — 0.00007 sec (very fast) | 50000 times — 3.69 sec (fast) | PHP 7.1.1, WP 4.7.2

Hooks from the function

sidebars_widgets

Returns

Array. An associative array where the key is the ID of the widget panel (sidebar), and the value is an array of all widgets from each panel, including the panel with inactive widgets.

Usage

wp_get_sidebars_widgets( $deprecated = true );

$deprecated(boolean): Not used. The parameter is deprecated.
Default: true

Examples

#1 What the function returns

$wg = wp_get_sidebars_widgets();

/* $wg
Array
(
	[wp_inactive_widgets] => Array
		(
			[0] => text-8
			[1] => text-5
		)

	[sidebar] => Array
		(
			[0] => democracy-2
			[0] => text-1
		)

)
*/

#2 Count the number of widgets in the sidebar

Suppose we need to do something depending on how many widgets are in the panel. For example, there is a horizontal sidebar where you can add any number of widgets. We need to set a different CSS class for each of them depending on their quantity.

For example, if there is one widget in the sidebar, then col-lg-12. If there are two - then col-lg-6.

To do this, we find out the name of the required sidebar, let's say it is sidebar_horizontal.

$wg = wp_get_sidebars_widgets();
$myid = 'sidebar_horizontal';

// the required sidebar exists
if( isset($wg['sidebar_horizontal']) ){
	$wgcount = count($wg[$myid]);

	$class = 'col-lg-12';

	if( $wgcount == 2 )     $class = 'col-lg-6';
	elseif( $wgcount == 3 ) $class = 'col-lg-4';
	elseif( $wgcount == 4 ) $class = 'col-lg-3';

	// set the class via hook 
	add_filter('dynamic_sidebar_params', function($param) use($class){

		foreach( $param as & $data ){
			if( $data['id'] == $myid ){
				$data['before_widget'] = str_replace('class="','class="'. $class .' ', $data['before_widget'] );
			}
		}

		return $param;
	});

}

// output the widgets
dynamic_sidebar('sidebar');

Notes

Global. Array. $_wp_sidebars_widgets
Global. Array. $sidebars_widgets

Changelog

Since 2.2.0

Introduced.

`wp_get_sidebars_widgets() wp get sidebars widgets` code ^{WP 6.9}

wp-includes/widgets.php

function wp_get_sidebars_widgets( $deprecated = true ) {
	if ( true !== $deprecated ) {
		_deprecated_argument( __FUNCTION__, '2.8.1' );
	}

	global $_wp_sidebars_widgets, $sidebars_widgets;

	/*
	 * If loading from front page, consult $_wp_sidebars_widgets rather than options
	 * to see if wp_convert_widget_settings() has made manipulations in memory.
	 */
	if ( ! is_admin() ) {
		if ( empty( $_wp_sidebars_widgets ) ) {
			$_wp_sidebars_widgets = get_option( 'sidebars_widgets', array() );
		}

		$sidebars_widgets = $_wp_sidebars_widgets;
	} else {
		$sidebars_widgets = get_option( 'sidebars_widgets', array() );
	}

	if ( is_array( $sidebars_widgets ) && isset( $sidebars_widgets['array_version'] ) ) {
		unset( $sidebars_widgets['array_version'] );
	}

	/**
	 * Filters the list of sidebars and their widgets.
	 *
	 * @since 2.7.0
	 *
	 * @param array $sidebars_widgets An associative array of sidebars and their widgets.
	 */
	return apply_filters( 'sidebars_widgets', $sidebars_widgets );
}