Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-24 21:32:51 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Improve documentation of the `$wp_registered_sidebars global.

Browse Source 
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
This commit is contained in:
Gary Pendergast 2019-01-14 23:01:49 +00:00
parent a7d0293446
commit 767fb99e94
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-includes/version.php
View File

@ -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.

16
wp-includes/widgets.php
View File

@ -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
*