wp_get_sidebars_widgets
Retrieve full list of sidebars and their widget instance IDs.
Description
(array) wp_get_sidebars_widgets( (bool) $deprecated = true );
Will upgrade sidebar widget list, if needed. Will also save updated list, if needed.
Returns (array)
Upgraded list of widgets to version 3 array format when called from the admin.
Parameters (1)
- 0. $deprecated — Optional. (bool) =>
true
- Not used (argument deprecated).
Usage
if ( !function_exists( 'wp_get_sidebars_widgets' ) ) { require_once ABSPATH . WPINC . '/widgets.php'; } // Not used (argument deprecated). $deprecated = true; // NOTICE! Understand what this does before running. $result = wp_get_sidebars_widgets($deprecated);
Defined (1)
The function is defined in the following location(s).
- /wp-includes/widgets.php
- function wp_get_sidebars_widgets( $deprecated = true ) {
- if ( $deprecated !== true )
- _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 );
- }