wp_get_sidebars_widgets( bool $deprecated = true ): array

Description

Parameters

$deprecatedbooloptional

Not used (argument deprecated).Default: true

Return

array

Upgraded list of widgets to version 3 array format when called from the admin.

Hooks fired · 1

One hook fires while wp_get_sidebars_widgets() runs, in this order:

1. 1
   apply_filters( sidebars_widgets )filterline 1053 (+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.

Source

View on Trac ↗View on GitHub ↗

1021function wp_get_sidebars_widgets( $deprecated = true ) {1022	if ( true !== $deprecated ) {1023		_deprecated_argument( __FUNCTION__, '2.8.1' );1024	}1025 1026	global $_wp_sidebars_widgets, $sidebars_widgets;1027 1028	/*1029	 * If loading from front page, consult $_wp_sidebars_widgets rather than options1030	 * to see if wp_convert_widget_settings() has made manipulations in memory.1031	 */1032	if ( ! is_admin() ) {1033		if ( empty( $_wp_sidebars_widgets ) ) {1034			$_wp_sidebars_widgets = get_option( 'sidebars_widgets', array() );1035		}1036 1037		$sidebars_widgets = $_wp_sidebars_widgets;1038	} else {1039		$sidebars_widgets = get_option( 'sidebars_widgets', array() );1040	}1041 1042	if ( is_array( $sidebars_widgets ) && isset( $sidebars_widgets['array_version'] ) ) {1043		unset( $sidebars_widgets['array_version'] );1044	}1045 1046	/**1047	 * Filters the list of sidebars and their widgets.1048	 *1049	 * @since 2.7.01050	 *1051	 * @param array $sidebars_widgets An associative array of sidebars and their widgets.1052	 */1053	return apply_filters( 'sidebars_widgets', $sidebars_widgets );1054}

History

Introduced in 2.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 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.