Changeset 61638

Timestamp:

02/13/2026 06:33:22 PM (3 months ago)

Author:

westonruter

Message:

Docs: Add missing @global variable descriptions.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10864

Follow-up to [61604], [61592].

Props noruzzaman, huzaifaalmesbah, shailu25, sabernhardt, westonruter.
See #64224.

Location:

trunk/src/wp-admin

Files:

• includes/ajax-actions.php (modified) (7 diffs)
• includes/class-core-upgrader.php (modified) (1 diff)
• includes/class-custom-image-header.php (modified) (1 diff)
• includes/class-theme-upgrader.php (modified) (1 diff)
• includes/class-walker-nav-menu-checklist.php (modified) (1 diff)
• includes/class-walker-nav-menu-edit.php (modified) (1 diff)
• includes/class-wp-comments-list-table.php (modified) (6 diffs)
• install.php (modified) (1 diff)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -1242 +1242 @@
  * @since 3.1.0
  *
- * @global int $post_id
+ * @global int $post_id Post ID.
  *
  * @param string $action Action to perform.
@@ -2354 +2354 @@
  * @since 3.1.0
  *
- * @global array $wp_registered_widgets
- * @global array $wp_registered_widget_controls
- * @global array $wp_registered_widget_updates
+ * @global array $wp_registered_widgets         Registered widgets.
+ * @global array $wp_registered_widget_controls Registered widget controls.
+ * @global array $wp_registered_widget_updates  Registered widget updates.
  */
 function wp_ajax_save_widget() {
@@ -2463 +2463 @@
  * @since 3.9.0
  *
- * @global WP_Customize_Manager $wp_customize
+ * @global WP_Customize_Manager $wp_customize Customizer manager object.
  */
 function wp_ajax_update_widget() {
@@ -3589 +3589 @@
  * @since 3.8.0
  *
- * @global array $_wp_admin_css_colors
+ * @global array $_wp_admin_css_colors Registered admin CSS color schemes.
  */
 function wp_ajax_save_user_color_scheme() {
@@ -3618 +3618 @@
  * @since 3.9.0
  *
- * @global array $themes_allowedtags
- * @global array $theme_field_defaults
+ * @global array $themes_allowedtags   Allowed HTML tags for theme descriptions.
+ * @global array $theme_field_defaults Default theme fields.
  */
 function wp_ajax_query_themes() {
@@ -3751 +3751 @@
  * @global WP_Post    $post          Global post object.
  * @global WP_Embed   $wp_embed      WordPress Embed object.
- * @global WP_Scripts $wp_scripts
- * @global int        $content_width
+ * @global WP_Scripts $wp_scripts    Script dependencies object.
+ * @global int        $content_width Shared post content width.
  */
 function wp_ajax_parse_embed() {
@@ -3892 +3892 @@
  *
  * @global WP_Post    $post       Global post object.
- * @global WP_Scripts $wp_scripts
+ * @global WP_Scripts $wp_scripts Script dependencies object.
  */
 function wp_ajax_parse_media_shortcode() {

trunk/src/wp-admin/includes/class-core-upgrader.php

@@ -49 +49 @@
      *
      * @global WP_Filesystem_Base $wp_filesystem                WordPress filesystem subclass.
-     * @global callable           $_wp_filesystem_direct_method
+     * @global callable           $_wp_filesystem_direct_method Filesystem direct method callback.
      *
      * @param object $current Response object for whether WordPress is current.

trunk/src/wp-admin/includes/class-custom-image-header.php

@@ -269 +269 @@
      * @since 3.0.0
      *
-     * @global array $_wp_default_headers
+     * @global array $_wp_default_headers Default headers registered for themes.
      */
     public function process_default_headers() {

trunk/src/wp-admin/includes/class-theme-upgrader.php

@@ -747 +747 @@
      * @since 2.8.0
      *
-     * @global WP_Filesystem_Base $wp_filesystem Subclass
+     * @global WP_Filesystem_Base $wp_filesystem Filesystem subclass.
      *
      * @param bool   $removed

trunk/src/wp-admin/includes/class-walker-nav-menu-checklist.php

@@ -65 +65 @@
      *              to match parent class for PHP 8 named parameter support.
      *
-     * @global int        $_nav_menu_placeholder
-     * @global int|string $nav_menu_selected_id
+     * @global int        $_nav_menu_placeholder A placeholder for the nav menu item ID.
+     * @global int|string $nav_menu_selected_id  The ID of the selected nav menu.
      *
      * @param string   $output            Used to append additional content (passed by reference).

trunk/src/wp-admin/includes/class-walker-nav-menu-edit.php

@@ -50 +50 @@
      *              to match parent class for PHP 8 named parameter support.
      *
-     * @global int $_wp_nav_menu_max_depth
+     * @global int $_wp_nav_menu_max_depth The maximum depth of the nav menu.
      *
      * @param string   $output            Used to append additional content (passed by reference).

trunk/src/wp-admin/includes/class-wp-comments-list-table.php

@@ -32 +32 @@
      * @see WP_List_Table::__construct() for more information on default arguments.
      *
-     * @global int $post_id
+     * @global int $post_id The ID of the post to show comments for.
      *
      * @param array $args An associative array of arguments.
@@ -225 +225 @@
     /**
      * Displays a message when no comments are found.
-     *
-     * @global string $comment_status
+     * @global string $comment_status The current comment status filter.
      */
     public function no_items() {
@@ -243 +242 @@
      * Returns an array of comment status links.
      *
-     * @global int    $post_id
-     * @global string $comment_status
-     * @global string $comment_type
+     * @global int    $post_id        The ID of the post to show comments for.
+     * @global string $comment_status The current comment status.
+     * @global string $comment_type   The current comment type.
      *
      * @return array<string, string> Comment status HTML links keyed by view.
@@ -413 +412 @@
      * Displays extra controls between bulk actions and pagination.
      *
-     * @global string $comment_status
-     * @global string $comment_type
+     * @global string $comment_status Current comment status.
+     * @global string $comment_type   Current comment type.
      *
      * @param string $which The location of the extra table nav markup: Either 'top' or 'bottom'.
@@ -486 +485 @@
      * Gets the list of columns.
      *
-     * @global int $post_id
+     * @global int $post_id The ID of the post comments are being shown for.
      *
      * @return string[] Array of column titles keyed by their column name.
@@ -1012 +1011 @@
      * Outputs the author column.
      *
-     * @global string $comment_status
+     * @global string $comment_status The current comment status.
      *
      * @param WP_Comment $comment The comment object.

trunk/src/wp-admin/install.php

@@ -343 +343 @@
  * @global string    $wp_local_package Locale code of the package.
  * @global WP_Locale $wp_locale        WordPress date and time locale object.
+ * @global wpdb      $wpdb             WordPress database abstraction object.
  */
 $language = '';