From 767fb99e941ef7be5b4859edf30a1c891f09c9a7 Mon Sep 17 00:00:00 2001 From: Gary Pendergast Date: Mon, 14 Jan 2019 23:01:49 +0000 Subject: [PATCH] Docs: Improve documentation of the ``$wp_registered_sidebars` global. Props mukesh27. Fixes #43448. Built from https://develop.svn.wordpress.org/trunk@44585 git-svn-id: http://core.svn.wordpress.org/trunk@44416 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/version.php | 2 +- wp-includes/widgets.php | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/wp-includes/version.php b/wp-includes/version.php index 93ca70f725..1ec9aab564 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.1-beta1-44584'; +$wp_version = '5.1-beta1-44585'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. diff --git a/wp-includes/widgets.php b/wp-includes/widgets.php index c8030eb88b..c2c3067ec9 100644 --- a/wp-includes/widgets.php +++ b/wp-includes/widgets.php @@ -28,7 +28,7 @@ global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_co /** * Stores the sidebars, since many themes can have more than one. * - * @global array $wp_registered_sidebars + * @global array $wp_registered_sidebars Registered sidebars. * @since 2.2.0 */ $wp_registered_sidebars = array(); @@ -148,7 +148,7 @@ function unregister_widget( $widget ) { * * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here. * - * @global array $wp_registered_sidebars + * @global array $wp_registered_sidebars The new sidebars are stored in this array by sidebar ID. * * @param int $number Optional. Number of sidebars to create. Default 1. * @param array|string $args { @@ -285,7 +285,7 @@ function register_sidebar( $args = array() ) { * * @since 2.2.0 * - * @global array $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID. + * @global array $wp_registered_sidebars Removes the sidebar from this array by sidebar ID. * * @param string|int $sidebar_id The ID of the sidebar when it was registered. */ @@ -413,7 +413,7 @@ function wp_widget_description( $id ) { * * @since 2.9.0 * - * @global array $wp_registered_sidebars + * @global array $wp_registered_sidebars Registered sidebars. * * @param string $id sidebar ID. * @return string|void Sidebar description, if available. @@ -625,7 +625,7 @@ function wp_unregister_widget_control( $id ) { * * @since 2.2.0 * - * @global array $wp_registered_sidebars + * @global array $wp_registered_sidebars Registered sidebars. * @global array $wp_registered_widgets * * @param int|string $index Optional, default is 1. Index, name or ID of dynamic sidebar. @@ -863,7 +863,7 @@ function is_active_widget( $callback = false, $widget_id = false, $id_base = fal * @since 2.2.0 * * @global array $wp_registered_widgets - * @global array $wp_registered_sidebars + * @global array $wp_registered_sidebars Registered sidebars. * * @return bool True, if using widgets. False, if not using widgets. */ @@ -991,7 +991,7 @@ function wp_set_sidebars_widgets( $sidebars_widgets ) { * @since 2.2.0 * @access private * - * @global array $wp_registered_sidebars + * @global array $wp_registered_sidebars Registered sidebars. * * @return array */ @@ -1171,7 +1171,7 @@ function _wp_sidebars_changed() { * * @since 2.8.0 * - * @global array $wp_registered_sidebars + * @global array $wp_registered_sidebars Registered sidebars. * @global array $sidebars_widgets * @global array $wp_registered_widgets *