Make WordPress Core

Changeset 57370


Ignore:
Timestamp:
01/28/2024 08:17:54 AM (3 months ago)
Author:
audrasjb
Message:

Docs: Improve various globals documentation, as per docblock standards.

Props upadalavipul, audrasjb, shailu25, viralsampat.
Fixes #59255.
See #59651.

Location:
trunk/src/wp-includes
Files:
2 edited

Legend:

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

    r55644 r57370  
    632632 *
    633633 * @since 1.5.0
     634 *
     635 * @global string $wp_version The WordPress version string.
     636 *
    634637 * @package External
    635638 * @subpackage MagpieRSS
  • trunk/src/wp-includes/widgets.php

    r57234 r57370  
    2929 * Stores the sidebars, since many themes can have more than one.
    3030 *
    31  * @global array $wp_registered_sidebars Registered sidebars.
     31 * @global array $wp_registered_sidebars The registered sidebars.
    3232 * @since 2.2.0
    3333 */
     
    3737 * Stores the registered widgets.
    3838 *
    39  * @global array $wp_registered_widgets
     39 * @global array $wp_registered_widgets The registered widgets.
    4040 * @since 2.2.0
    4141 */
     
    4545 * Stores the registered widget controls (options).
    4646 *
    47  * @global array $wp_registered_widget_controls
     47 * @global array $wp_registered_widget_controls The registered widget controls.
    4848 * @since 2.2.0
    4949 */
    5050$wp_registered_widget_controls = array();
    5151/**
    52  * @global array $wp_registered_widget_updates
     52 * @global array $wp_registered_widget_updates The registered widget updates.
    5353 */
    5454$wp_registered_widget_updates = array();
     
    225225 * @since 5.9.0 Added the `show_in_rest` argument.
    226226 *
    227  * @global array $wp_registered_sidebars Registered sidebars.
     227 * @global array $wp_registered_sidebars The registered sidebars.
    228228 *
    229229 * @param array|string $args {
     
    327327 * @since 2.2.0
    328328 *
    329  * @global array $wp_registered_sidebars Registered sidebars.
     329 * @global array $wp_registered_sidebars The registered sidebars.
    330330 *
    331331 * @param string|int $sidebar_id The ID of the sidebar when it was registered.
     
    342342 * @since 4.4.0
    343343 *
    344  * @global array $wp_registered_sidebars Registered sidebars.
     344 * @global array $wp_registered_sidebars The registered sidebars.
    345345 *
    346346 * @param string|int $sidebar_id The ID of the sidebar when it was registered.
     
    368368 * @global array $wp_registered_widgets            Uses stored registered widgets.
    369369 * @global array $wp_registered_widget_controls    Stores the registered widget controls (options).
    370  * @global array $wp_registered_widget_updates
     370 * @global array $wp_registered_widget_updates     The registered widget updates.
    371371 * @global array $_wp_deprecated_widgets_callbacks
    372372 *
     
    436436 * @since 2.5.0
    437437 *
    438  * @global array $wp_registered_widgets
     438 * @global array $wp_registered_widgets The registered widgets.
    439439 *
    440440 * @param int|string $id Widget ID.
     
    461461 * @since 2.9.0
    462462 *
    463  * @global array $wp_registered_sidebars Registered sidebars.
     463 * @global array $wp_registered_sidebars The registered sidebars.
    464464 *
    465465 * @param string $id sidebar ID.
     
    507507 *              by adding it to the function signature.
    508508 *
    509  * @global array $wp_registered_widget_controls
    510  * @global array $wp_registered_widget_updates
    511  * @global array $wp_registered_widgets
     509 * @global array $wp_registered_widget_controls The registered widget controls.
     510 * @global array $wp_registered_widget_updates  The registered widget updates.
     511 * @global array $wp_registered_widgets         The registered widgets.
    512512 * @global array $_wp_deprecated_widgets_callbacks
    513513 *
     
    584584 *              by adding it to the function signature.
    585585 *
    586  * @global array $wp_registered_widget_updates
     586 * @global array $wp_registered_widget_updates The registered widget updates.
    587587 *
    588588 * @param string   $id_base         The base ID of a widget created by extending WP_Widget.
     
    618618 *              by adding it to the function signature.
    619619 *
    620  * @global array $wp_registered_widget_controls
     620 * @global array $wp_registered_widget_controls The registered widget controls.
    621621 *
    622622 * @param int|string $id            Widget ID.
     
    681681 * @since 2.2.0
    682682 *
    683  * @global array $wp_registered_sidebars Registered sidebars.
    684  * @global array $wp_registered_widgets  Registered widgets.
     683 * @global array $wp_registered_sidebars The registered sidebars.
     684 * @global array $wp_registered_widgets  The registered widgets.
    685685 *
    686686 * @param int|string $index Optional. Index, name or ID of dynamic sidebar. Default 1.
     
    892892 * @since 2.2.0
    893893 *
    894  * @global array $wp_registered_widgets
     894 * @global array $wp_registered_widgets The registered widgets.
    895895 *
    896896 * @param callable|false $callback      Optional. Widget callback to check. Default false.
     
    938938 * @since 2.2.0
    939939 *
    940  * @global array $wp_registered_widgets  Registered widgets.
    941  * @global array $wp_registered_sidebars Registered sidebars.
     940 * @global array $wp_registered_widgets  The registered widgets.
     941 * @global array $wp_registered_sidebars The registered sidebars.
    942942 *
    943943 * @return bool True if using widgets, false otherwise.
     
    11011101 * @access private
    11021102 *
    1103  * @global array $wp_registered_sidebars Registered sidebars.
     1103 * @global array $wp_registered_sidebars The registered sidebars.
    11041104 *
    11051105 * @return array
     
    13071307 * @since 2.8.0
    13081308 *
    1309  * @global array $wp_registered_sidebars Registered sidebars.
     1309 * @global array $wp_registered_sidebars The registered sidebars.
    13101310 * @global array $sidebars_widgets
    1311  * @global array $wp_registered_widgets  Registered widgets.
     1311 * @global array $wp_registered_widgets  The registered widgets.
    13121312 *
    13131313 * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value
     
    15471547 * @since 4.9.0
    15481548 *
    1549  * @global array $wp_registered_widgets
     1549 * @global array $wp_registered_widgets The registered widgets.
    15501550 *
    15511551 * @param array $sidebars_widgets   List of sidebars and their widget instance IDs.
     
    19731973 * @since 5.8.0
    19741974 *
    1975  * @global array $wp_registered_widgets
    1976  * @global array $wp_registered_sidebars
     1975 * @global array $wp_registered_widgets  The registered widgets.
     1976 * @global array $wp_registered_sidebars The registered sidebars.
    19771977 *
    19781978 * @param string $widget_id Widget ID.
     
    20422042 * @since 5.8.0
    20432043 *
    2044  * @global array $wp_registered_widget_controls
     2044 * @global array $wp_registered_widget_controls The registered widget controls.
    20452045 *
    20462046 * @param string $id Widget ID.
     
    21262126 * @access private
    21272127 *
    2128  * @global array $wp_registered_sidebars Registered sidebars.
     2128 * @global array $wp_registered_sidebars The registered sidebars.
    21292129 */
    21302130function _wp_block_theme_register_classic_sidebars() {
Note: See TracChangeset for help on using the changeset viewer.