Changeset 61717

Timestamp:

02/23/2026 06:05:17 AM (2 months ago)

Author:

westonruter

Message:

Docs: Supply missing documentation in WP_MS_Themes_List_Table.

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

Props noruzzaman, westonruter, huzaifaalmesbah.
See #64224.

File:

• trunk/src/wp-admin/includes/class-wp-ms-themes-list-table.php (modified) (15 diffs)

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

@@ -38 +38 @@
      * @see WP_List_Table::__construct() for more information on default arguments.
      *
-     * @global string $status
-     * @global int    $page
+     * @global string $status The current theme status.
+     * @global int    $page   The current page number.
      *
      * @param array $args An associative array of arguments.
@@ -71 +71 @@
 
     /**
-     * @return array
+     * Gets the list of CSS classes for the table tag.
+     *
+     * @return string[] The list of CSS classes.
      */
     protected function get_table_classes() {
@@ -79 +81 @@
 
     /**
-     * @return bool
+     * Checks if the current user has permissions to perform AJAX actions.
+     *
+     * @return bool True if the current user has permissions, false otherwise.
      */
     public function ajax_user_can() {
@@ -90 +94 @@
 
     /**
-     * @global string $status
-     * @global array $totals
-     * @global int $page
-     * @global string $orderby
-     * @global string $order
-     * @global string $s
+     * Prepares the themes list for display.
+     *
+     * @global string             $status  The current theme status.
+     * @global array<string, int> $totals  An array of theme counts for each status.
+     * @global int                $page    The current page number.
+     * @global string             $orderby The column to order the themes list by.
+     * @global string             $order   The order of the themes list (ASC or DESC).
+     * @global string             $s       The search string.
      */
     public function prepare_items() {
@@ -262 +268 @@
 
     /**
-     * @param WP_Theme $theme
-     * @return bool
+     * Filters a theme by the search term.
+     *
+     * @param WP_Theme $theme The WP_Theme object to check.
+     * @return bool True if the theme matches the search term, false otherwise.
      */
     public function _search_callback( $theme ) {
@@ -291 +299 @@
     // Not used by any core columns.
     /**
-     * @global string $orderby
-     * @global string $order
-     * @param array $theme_a
-     * @param array $theme_b
-     * @return int
+     * Compares the order of two themes by a specific field.
+     *
+     * @global string $orderby The column to order the themes list by.
+     * @global string $order   The order of the themes list (ASC or DESC).
+     *
+     * @param WP_Theme $theme_a The first theme to compare.
+     * @param WP_Theme $theme_b The second theme to compare.
+     * @return int 0 if equal, -1 if the first is less than the second, 1 if more.
      */
     public function _order_callback( $theme_a, $theme_b ) {
@@ -309 +320 @@
 
     /**
+     * Displays the message when there are no items to list.
      */
     public function no_items() {
@@ -319 +331 @@
 
     /**
-     * @return string[] Array of column titles keyed by their column name.
+     * Gets the list of columns for the list table.
+     *
+     * @return array<string, string> Array of column titles keyed by their column name.
      */
     public function get_columns() {
@@ -336 +350 @@
 
     /**
-     * @return array
+     * Gets the list of sortable columns for the list table.
+     *
+     * @return array<string, array<int, mixed>> An array of sortable columns.
      */
     protected function get_sortable_columns() {
@@ -356 +372 @@
 
     /**
-     * @global array $totals
-     * @global string $status
-     * @return array
+     * Gets the list of views (statuses) for the list table.
+     *
+     * @global array<string, int> $totals An array of theme counts for each status.
+     * @global string             $status The current theme status.
+     *
+     * @return array<string, string> The list of views.
      */
     protected function get_views() {
@@ -452 +471 @@
 
     /**
-     * @global string $status
-     *
-     * @return array
+     * Gets the list of bulk actions for the list table.
+     *
+     * @global string $status The current theme status.
+     *
+     * @return array<string, string> The list of bulk actions.
      */
     protected function get_bulk_actions() {
@@ -533 +554 @@
      * @since 4.3.0
      *
-     * @global string $status
-     * @global int    $page
-     * @global string $s
+     * @global string $status The current theme status.
+     * @global int    $page   The current page number.
+     * @global string $s      The search string.
      *
      * @param WP_Theme $theme The current WP_Theme object.
@@ -690 +711 @@
      * @since 4.3.0
      *
-     * @global string $status
-     * @global array  $totals
+     * @global string             $status The current theme status.
+     * @global array<string, int> $totals An array of theme counts for each status.
      *
      * @param WP_Theme $theme The current WP_Theme object.
@@ -778 +799 @@
      * @since 5.5.0
      *
-     * @global string $status
-     * @global int  $page
+     * @global string $status The current theme status.
+     * @global int    $page   The current page number.
      *
      * @param WP_Theme $theme The current WP_Theme object.
@@ -980 +1001 @@
 
     /**
-     * @global string $status
-     * @global array  $totals
-     *
-     * @param WP_Theme $theme
+     * Handles the output for a single table row.
+     *
+     * @global string             $status The current theme status.
+     * @global array<string, int> $totals An array of theme counts for each status.
+     *
+     * @param WP_Theme $theme The current WP_Theme object.
      */
     public function single_row( $theme ) {