WP_Customize_Widgets::preview_sidebars_widgets() WordPress Method
The WP_Customize_Widgets::preview_sidebars_widgets() method is used to preview how widgets will be displayed in sidebars on the front-end of a WordPress site. This is useful for making sure that widgets are properly aligned and sized before they are published.
WP_Customize_Widgets::preview_sidebars_widgets( array $sidebars_widgets ) #
When previewing, ensures the proper previewing widgets are used.
Description
Because wp_get_sidebars_widgets() gets called early at ‘init’ (via wp_convert_widget_settings()) and can set global variable $_wp_sidebars_widgets to the value of get_option( 'sidebars_widgets' ) before the Customizer preview filter is added, it has to be reset after the filter has been added.
Parameters
- $sidebars_widgets
(array)(Required)List of widgets for the current sidebar.
Return
(array)
Source
File: wp-includes/class-wp-customize-widgets.php
public function preview_sidebars_widgets( $sidebars_widgets ) {
$sidebars_widgets = get_option( 'sidebars_widgets', array() );
unset( $sidebars_widgets['array_version'] );
return $sidebars_widgets;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 3.9.0 | Introduced. |