Changeset 57370

Timestamp:

01/28/2024 08:17:54 AM (6 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:

• rss.php (modified) (1 diff)
• widgets.php (modified) (21 diffs)

trunk/src/wp-includes/rss.php

@@ -632 +632 @@
  *
  * @since 1.5.0
+
+
+
  * @package External
  * @subpackage MagpieRSS

trunk/src/wp-includes/widgets.php

@@ -29 +29 @@
  * Stores the sidebars, since many themes can have more than one.
  *
- * @global array $wp_registered_sidebars Registered sidebars.
+ * @global array $wp_registered_sidebars egistered sidebars.
  * @since 2.2.0
  */
@@ -37 +37 @@
  * Stores the registered widgets.
  *
- * @global array $wp_registered_widgets
+ * @global array $wp_registered_widgets
  * @since 2.2.0
  */
@@ -45 +45 @@
  * Stores the registered widget controls (options).
  *
- * @global array $wp_registered_widget_controls
+ * @global array $wp_registered_widget_controls
  * @since 2.2.0
  */
 $wp_registered_widget_controls = array();
 /**
- * @global array $wp_registered_widget_updates
+ * @global array $wp_registered_widget_updates
  */
 $wp_registered_widget_updates = array();
@@ -225 +225 @@
  * @since 5.9.0 Added the `show_in_rest` argument.
  *
- * @global array $wp_registered_sidebars Registered sidebars.
+ * @global array $wp_registered_sidebars egistered sidebars.
  *
  * @param array|string $args {
@@ -327 +327 @@
  * @since 2.2.0
  *
- * @global array $wp_registered_sidebars Registered sidebars.
+ * @global array $wp_registered_sidebars egistered sidebars.
  *
  * @param string|int $sidebar_id The ID of the sidebar when it was registered.
@@ -342 +342 @@
  * @since 4.4.0
  *
- * @global array $wp_registered_sidebars Registered sidebars.
+ * @global array $wp_registered_sidebars egistered sidebars.
  *
  * @param string|int $sidebar_id The ID of the sidebar when it was registered.
@@ -368 +368 @@
  * @global array $wp_registered_widgets            Uses stored registered widgets.
  * @global array $wp_registered_widget_controls    Stores the registered widget controls (options).
- * @global array $wp_registered_widget_updates
+ * @global array $wp_registered_widget_updates
  * @global array $_wp_deprecated_widgets_callbacks
  *
@@ -436 +436 @@
  * @since 2.5.0
  *
- * @global array $wp_registered_widgets
+ * @global array $wp_registered_widgets
  *
  * @param int|string $id Widget ID.
@@ -461 +461 @@
  * @since 2.9.0
  *
- * @global array $wp_registered_sidebars Registered sidebars.
+ * @global array $wp_registered_sidebars egistered sidebars.
  *
  * @param string $id sidebar ID.
@@ -507 +507 @@
  *              by adding it to the function signature.
  *
- * @global array $wp_registered_widget_controls
- * @global array $wp_registered_widget_updates
- * @global array $wp_registered_widgets
+ * @global array $wp_registered_widget_controls
+ * @global array $wp_registered_widget_updates
+ * @global array $wp_registered_widgets
  * @global array $_wp_deprecated_widgets_callbacks
  *
@@ -584 +584 @@
  *              by adding it to the function signature.
  *
- * @global array $wp_registered_widget_updates
+ * @global array $wp_registered_widget_updates
  *
  * @param string   $id_base         The base ID of a widget created by extending WP_Widget.
@@ -618 +618 @@
  *              by adding it to the function signature.
  *
- * @global array $wp_registered_widget_controls
+ * @global array $wp_registered_widget_controls
  *
  * @param int|string $id            Widget ID.
@@ -681 +681 @@
  * @since 2.2.0
  *
- * @global array $wp_registered_sidebars Registered sidebars.
- * @global array $wp_registered_widgets  Registered widgets.
+ * @global array $wp_registered_sidebars egistered sidebars.
+ * @global array $wp_registered_widgets  egistered widgets.
  *
  * @param int|string $index Optional. Index, name or ID of dynamic sidebar. Default 1.
@@ -892 +892 @@
  * @since 2.2.0
  *
- * @global array $wp_registered_widgets
+ * @global array $wp_registered_widgets
  *
  * @param callable|false $callback      Optional. Widget callback to check. Default false.
@@ -938 +938 @@
  * @since 2.2.0
  *
- * @global array $wp_registered_widgets  Registered widgets.
- * @global array $wp_registered_sidebars Registered sidebars.
+ * @global array $wp_registered_widgets  egistered widgets.
+ * @global array $wp_registered_sidebars egistered sidebars.
  *
  * @return bool True if using widgets, false otherwise.
@@ -1101 +1101 @@
  * @access private
  *
- * @global array $wp_registered_sidebars Registered sidebars.
+ * @global array $wp_registered_sidebars egistered sidebars.
  *
  * @return array
@@ -1307 +1307 @@
  * @since 2.8.0
  *
- * @global array $wp_registered_sidebars Registered sidebars.
+ * @global array $wp_registered_sidebars egistered sidebars.
  * @global array $sidebars_widgets
- * @global array $wp_registered_widgets  Registered widgets.
+ * @global array $wp_registered_widgets  egistered widgets.
  *
  * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value
@@ -1547 +1547 @@
  * @since 4.9.0
  *
- * @global array $wp_registered_widgets
+ * @global array $wp_registered_widgets
  *
  * @param array $sidebars_widgets   List of sidebars and their widget instance IDs.
@@ -1973 +1973 @@
  * @since 5.8.0
  *
- * @global array $wp_registered_widgets
- * @global array $wp_registered_sidebars
+ * @global array $wp_registered_widgets
+ * @global array $wp_registered_sidebars
  *
  * @param string $widget_id Widget ID.
@@ -2042 +2042 @@
  * @since 5.8.0
  *
- * @global array $wp_registered_widget_controls
+ * @global array $wp_registered_widget_controls
  *
  * @param string $id Widget ID.
@@ -2126 +2126 @@
  * @access private
  *
- * @global array $wp_registered_sidebars Registered sidebars.
+ * @global array $wp_registered_sidebars egistered sidebars.
  */
 function _wp_block_theme_register_classic_sidebars() {