WordPress.org

Make WordPress Core

Changeset 44585


Ignore:
Timestamp:
01/14/2019 11:00:05 PM (3 years ago)
Author:
pento
Message:

Docs: Improve documentation of the $wp_registered_sidebars` global.

Props mukesh27.
Fixes #43448.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/widgets.php

    r43571 r44585  
    2929 * Stores the sidebars, since many themes can have more than one.
    3030 *
    31  * @global array $wp_registered_sidebars
     31 * @global array $wp_registered_sidebars Registered sidebars.
    3232 * @since 2.2.0
    3333 */
     
    149149 * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here.
    150150 *
    151  * @global array $wp_registered_sidebars
     151 * @global array $wp_registered_sidebars The new sidebars are stored in this array by sidebar ID.
    152152 *
    153153 * @param int          $number Optional. Number of sidebars to create. Default 1.
     
    286286 * @since 2.2.0
    287287 *
    288  * @global array $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
     288 * @global array $wp_registered_sidebars Removes the sidebar from this array by sidebar ID.
    289289 *
    290290 * @param string|int $sidebar_id The ID of the sidebar when it was registered.
     
    414414 * @since 2.9.0
    415415 *
    416  * @global array $wp_registered_sidebars
     416 * @global array $wp_registered_sidebars Registered sidebars.
    417417 *
    418418 * @param string $id sidebar ID.
     
    626626 * @since 2.2.0
    627627 *
    628  * @global array $wp_registered_sidebars
     628 * @global array $wp_registered_sidebars Registered sidebars.
    629629 * @global array $wp_registered_widgets
    630630 *
     
    864864 *
    865865 * @global array $wp_registered_widgets
    866  * @global array $wp_registered_sidebars
     866 * @global array $wp_registered_sidebars Registered sidebars.
    867867 *
    868868 * @return bool True, if using widgets. False, if not using widgets.
     
    992992 * @access private
    993993 *
    994  * @global array $wp_registered_sidebars
     994 * @global array $wp_registered_sidebars Registered sidebars.
    995995 *
    996996 * @return array
     
    11721172 * @since 2.8.0
    11731173 *
    1174  * @global array $wp_registered_sidebars
     1174 * @global array $wp_registered_sidebars Registered sidebars.
    11751175 * @global array $sidebars_widgets
    11761176 * @global array $wp_registered_widgets
Note: See TracChangeset for help on using the changeset viewer.