wp_get_sidebars_widgets( bool $deprecated = true ): array
- Since
- 2.2.0
- Source
wp-includes/widgets.php:1019
Description
Will upgrade sidebar widget list, if needed. Will also save updated list, if needed.
Compatibility
- WordPress
- since 2.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$deprecatedbooloptional- Not used (argument deprecated).Default:
true
Return value
array- Upgraded list of widgets to version 3 array format when called from the admin.
Performance profile
How much work a call to wp_get_sidebars_widgets() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Moderate
- Scaling
- Constant
- Instructions
- 19–31
- Plugin surface
- 1 hook
- Called by
- 18
Reads stored settings via get_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 36.
Third-party callbacks on 'sidebars_widgets' run inside this call, and their cost is not bounded by anything here.
18 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - cacheobject cache
wp_cache_get()one call below wp_get_sidebars_widgets() - serializeserialisation
maybe_unserialize()one call below wp_get_sidebars_widgets()
Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_sidebars_widgets() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$deprecated is not null, false, long, double, string, array, object, resource && !is_admin() && !empty($_wp_sidebars_widgets) | 19–22 | is_admin(), apply_filters() |
$deprecated is not null, false, long, double, string, array, object, resource | 20–27 | is_admin(), get_option(), apply_filters() |
$deprecated is null, false, long, double, string, array, object, resource && !is_admin() && !empty($_wp_sidebars_widgets) | 23–26 | _deprecated_argument(), is_admin(), apply_filters() |
$deprecated is null, false, long, double, string, array, object, resource | 24–31 | _deprecated_argument(), is_admin(), get_option(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 36 instructions, 19–31 executed per call, 5 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while wp_get_sidebars_widgets() runs, in this order:
- apply_filters( sidebars_widgets )filterline 1051 (+32 into the body)
Filters the list of sidebars and their widgets.
Uses · 4
- _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
- is_admin()Determines whether the current request is for an administrative interface page.
- get_option()Retrieves an option value based on an option name.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 18
- WP_Customize_Widgets::customize_register()Registers Customizer settings and controls for all sidebars and widgets.
- WP_Customize_Widgets::override_sidebars_widgets_for_theme_switch()Override sidebars_widgets for theme switch.
- WP_REST_Sidebars_Controller::get_items()Retrieves the list of sidebars (active or inactive).
- WP_REST_Sidebars_Controller::get_items_permissions_check()Checks if a given request has access to get sidebars.
- WP_REST_Sidebars_Controller::prepare_item_for_response()Prepares a single sidebar output for response.
- WP_REST_Sidebars_Controller::update_item()Updates a sidebar.
- WP_REST_Widgets_Controller::delete_item()Deletes a widget.
- WP_REST_Widgets_Controller::get_items()Retrieves a collection of widgets.
- WP_REST_Widgets_Controller::get_items_permissions_check()Checks if a given request has access to get widgets.
- WP_REST_Widgets_Controller::update_item()Updates an existing widget.
- _wp_sidebars_changed()Handles sidebars config after theme change.
- dynamic_sidebar()Displays dynamic sidebar.
Show all 18
- is_active_sidebar()Determines whether a sidebar contains widgets.
- is_active_widget()Determines whether a given widget is displayed on the front end.
- wp_ajax_delete_inactive_widgets()Handles removing inactive widgets via AJAX.
- wp_ajax_save_widget()Handles saving a widget via AJAX.
- wp_assign_widget_to_sidebar()Assigns a widget to the given sidebar.
- wp_find_widgets_sidebar()Finds the sidebar that a given widget belongs to.
Source code
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 );}Changelog
Introduced in 2.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/widgets.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.