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

Timestamp:

02/13/2026 06:33:22 PM (8 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.

File:

• trunk/src/wp-admin/includes/class-wp-comments-list-table.php (modified) (6 diffs)

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.