Question

Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

wp_get_sidebars_widgets( bool $deprecated = true )

Retrieve full list of sidebars and their widget instance IDs.

---

description

Will upgrade sidebar widget list, if needed. Will also save updated list, if needed.

---

参数

$deprecated

(bool) (Optional) Not used (argument deprecated).

Default value: true

---

返回值

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

---

源代码

File: 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 );
}

---

更新日志

Version	description
2.2.0	Introduced.

---

相关函数

Uses

• wp-includes/load.php: is_admin()
• wp-includes/functions.php: _deprecated_argument()
• wp-includes/plugin.php: apply_filters()
• wp-includes/option.php: get_option()
• wp-includes/widgets.php: sidebars_widgets

---

Used By

• wp-admin/includes/ajax-actions.php: wp_ajax_delete_inactive_widgets()
• wp-admin/includes/ajax-actions.php: wp_ajax_save_widget()
• wp-includes/widgets.php: _wp_sidebars_changed()
• wp-includes/widgets.php: dynamic_sidebar()
• wp-includes/widgets.php: is_active_widget()
• wp-includes/widgets.php: is_active_sidebar()
• wp-includes/class-wp-customize-widgets.php: WP_Customize_Widgets::override_sidebars_widgets_for_theme_switch()
• wp-includes/class-wp-customize-widgets.php: WP_Customize_Widgets::customize_register()
Show 3 more used by Hide more used by

---

User Contributed Notes