Changeset 61657

Timestamp:

02/17/2026 06:04:42 AM (7 months ago)

Author:

westonruter

Message:

Docs: Add missing @global descriptions and refine parameter documentations in wp-admin/includes classes.

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

Follow-up to [61638].

Props noruzzaman, huzaifaalmesbah, westonruter.
See #64224.

Location:

trunk/src/wp-admin/includes

Files:

• class-wp-debug-data.php (modified) (1 diff)
• class-wp-importer.php (modified) (1 diff)
• class-wp-links-list-table.php (modified) (6 diffs)
• class-wp-list-table.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-debug-data.php

@@ -1133 +1133 @@
          * @since 6.7.0
          *
-         * @global array $_wp_theme_features
+         * @global array<string, bool|array> $_wp_theme_features The theme features for the active theme.
          *
          * @return array<string, string|array> The active theme debug data.

trunk/src/wp-admin/includes/class-wp-importer.php

@@ -280 +280 @@
          *
          * @global wpdb  $wpdb       WordPress database abstraction object.
-         * @global int[] $wp_actions
+         * @global int[] $wp_actions Stores the number of times each action was triggered.
          */
         public function stop_the_insanity() {

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

@@ -43 +43 @@
 
         /**
-         * @global int    $cat_id
-         * @global string $s
-         * @global string $orderby
-         * @global string $order
+         * @global int    $cat_id  Link category ID.
+         * @global string $s       Search string.
+         * @global string $orderby The field to order the links by.
+         * @global string $order   The direction to order the links.
          */
         public function prepare_items() {
@@ -78 +78 @@
 
         /**
+         * Displays the message for no items.
          */
         public function no_items() {
@@ -84 +85 @@
 
         /**
+         * Gets the list of bulk actions.
+         *
          * @return array
          */
@@ -94 +97 @@
 
         /**
-         * @global int $cat_id
-         * @param string $which
+         * @global int $cat_id Link category ID.
+         * @param string $which The location: 'top' or 'bottom'.
          */
         protected function extra_tablenav( $which ) {
@@ -143 +146 @@
 
         /**
+         * Gets the list of sortable columns.
+         *
          * @return array
          */
@@ -225 +230 @@
          * @since 4.3.0
          *
-         * @global int $cat_id
+         * @global int $cat_id Link category ID.
          *
          * @param object $link The current link object.

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

@@ -1693 +1693 @@
          * @since 3.1.0
          *
-         * @param string $which
+         * @param string $which The location: 'top' or 'bottom'.
          */
         protected function extra_tablenav( $which ) {}