Changeset 58200

Timestamp:

05/26/2024 08:49:30 PM (8 months ago)

Author:

SergeyBiryukov

Message:

Docs: Correct the placement of @global tags in various files.

Follow-up to [6589], [8598], [10798], [25490], [25594], [31192], [31194], [35718], [37437], [44169], [44948], [45247], [56763], [56773], [57370], [57503].

Props shailu25.
Fixes #61295.

Location:

trunk/src

Files:

• wp-admin/export.php (modified) (1 diff)
• wp-includes/class-wp-locale.php (modified) (2 diffs)
• wp-includes/feed.php (modified) (1 diff)
• wp-includes/functions.php (modified) (1 diff)
• wp-includes/functions.wp-scripts.php (modified) (3 diffs)
• wp-includes/functions.wp-styles.php (modified) (2 diffs)
• wp-includes/post.php (modified) (1 diff)
• wp-includes/script-modules.php (modified) (1 diff)
• wp-includes/widgets.php (modified) (1 diff)
• wp-includes/widgets/class-wp-nav-menu-widget.php (modified) (1 diff)

trunk/src/wp-admin/export.php

@@ -130 +130 @@
  * Creates the date options fields for exporting a given post type.
  *
+ * @since 3.1.0
+ *
  * @global wpdb      $wpdb      WordPress database abstraction object.
  * @global WP_Locale $wp_locale WordPress date and time locale object.
- *
- * @since 3.1.0
  *
  * @param string $post_type The post type. Default 'post'.

trunk/src/wp-includes/class-wp-locale.php

@@ -356 +356 @@
      * For backward compatibility only.
      *
+     * @since 2.1.0
      * @deprecated For backward compatibility only.
      *
@@ -363 +364 @@
      * @global array $month
      * @global array $month_abbrev
-     *
-     * @since 2.1.0
      */
     public function register_globals() {

trunk/src/wp-includes/feed.php

@@ -698 +698 @@
  * comment will be returned.
  *
+ * @since 5.2.0
+ *
  * @global WP_Query $wp_query WordPress Query object.
- *
- * @since 5.2.0
  *
  * @param string $format Date format string to return the time in.

trunk/src/wp-includes/functions.php

@@ -4763 +4763 @@
  * available.
  *
+ * @since 2.2.0
+ *
  * @global array $wpsmiliestrans
  * @global array $wp_smiliessearch
- *
- * @since 2.2.0
  */
 function smilies_init() {

trunk/src/wp-includes/functions.wp-scripts.php

@@ -12 +12 @@
  * Initializes $wp_scripts if it has not been set.
  *
+ * @since 4.2.0
+ *
  * @global WP_Scripts $wp_scripts
- *
- * @since 4.2.0
  *
  * @return WP_Scripts WP_Scripts instance.
@@ -78 +78 @@
  *
  * @see WP_Scripts::do_item()
+ * @since 2.1.0
+ *
  * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
- *
- * @since 2.1.0
  *
  * @param string|string[]|false $handles Optional. Scripts to be printed. Default 'false'.
@@ -235 +235 @@
  *
  * @see WP_Scripts::set_translations()
- * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
- *
  * @since 5.0.0
  * @since 5.1.0 The `$domain` parameter was made optional.
+ *
+ * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
  *
  * @param string $handle Script handle the textdomain will be attached to.

trunk/src/wp-includes/functions.wp-styles.php

@@ -12 +12 @@
  * Initializes $wp_styles if it has not been set.
  *
+ * @since 4.2.0
+ *
  * @global WP_Styles $wp_styles
- *
- * @since 4.2.0
  *
  * @return WP_Styles WP_Styles instance.
@@ -35 +35 @@
  * and passing an array of strings prints those styles.
  *
+ * @since 2.6.0
+ *
  * @global WP_Styles $wp_styles The WP_Styles object for printing styles.
- *
- * @since 2.6.0
  *
  * @param string|bool|array $handles Styles to be printed. Default 'false'.

trunk/src/wp-includes/post.php

@@ -7937 +7937 @@
  * Prime the cache containing the parent ID of various post objects.
  *
+ * @since 6.4.0
+ *
  * @global wpdb $wpdb WordPress database abstraction object.
- *
- * @since 6.4.0
  *
  * @param int[] $ids ID list.

trunk/src/wp-includes/script-modules.php

@@ -15 +15 @@
  * if it doesn't exist yet.
  *
+ * @since 6.5.0
+ *
  * @global WP_Script_Modules $wp_script_modules
- *
- * @since 6.5.0
  *
  * @return WP_Script_Modules The main WP_Script_Modules instance.

trunk/src/wp-includes/widgets.php

@@ -29 +29 @@
  * Stores the sidebars, since many themes can have more than one.
  *
+ * @since 2.2.0
+ *
  * @global array $wp_registered_sidebars The registered sidebars.
+ */
+$wp_registered_sidebars = array();
+
+/**
+ * Stores the registered widgets.
+ *
  * @since 2.2.0
- */
-$wp_registered_sidebars = array();
-
-/**
- * Stores the registered widgets.
  *
  * @global array $wp_registered_widgets The registered widgets.
+ */
+$wp_registered_widgets = array();
+
+/**
+ * Stores the registered widget controls (options).
+ *
  * @since 2.2.0
- */
-$wp_registered_widgets = array();
-
-/**
- * Stores the registered widget controls (options).
  *
  * @global array $wp_registered_widget_controls The registered widget controls.
- * @since 2.2.0
  */
 $wp_registered_widget_controls = array();
-/**
+
+/**
+ * Stores the registered widget updates.
+ *
+ * @since 2.8.0
+ *
  * @global array $wp_registered_widget_updates The registered widget updates.
  */

trunk/src/wp-includes/widgets/class-wp-nav-menu-widget.php

@@ -138 +138 @@
      * @since 3.0.0
      *
+     * @global WP_Customize_Manager $wp_customize
+     *
      * @param array $instance Current settings.
-     * @global WP_Customize_Manager $wp_customize
      */
     public function form( $instance ) {