Changeset 61683

Timestamp:

02/18/2026 11:21:46 PM (8 weeks ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing descriptions for WP_Media_List_Table methods.

Follow-up to [11749], [15491], [31162], [32654], [61594].

Props noruzzaman.
See #64224.

File:

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

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

@@ -24 +24 @@
     protected $comment_pending_count = array();
 
+    /**
+     * Whether the list table is for detached media.
+     *
+     * @since 3.1.0
+     * @var bool
+     */
     private $detached;
 
+    /**
+     * Whether the list table is for trash.
+     *
+     * @since 3.1.0
+     * @var bool
+     */
     private $is_trash;
 
@@ -54 +66 @@
 
     /**
+     * Checks if the current user has permissions to upload files.
+     *
+     * @since 3.1.0
+     *
      * @return bool Whether the user can upload files.
      */
@@ -61 +77 @@
 
     /**
+     * Prepares the list of items for displaying.
+     *
+     * @since 3.1.0
+     *
      * @global string   $mode                  List table view mode.
      * @global WP_Query $wp_query              WordPress Query object.
-     * @global array    $post_mime_types
-     * @global array    $avail_post_mime_types
+     * @global array    $post_mime_types       An array of post mime types.
+     * @global array    $avail_post_mime_types An array of available post mime types.
      */
     public function prepare_items() {
@@ -118 +138 @@
 
     /**
-     * @global array $post_mime_types
-     * @global array $avail_post_mime_types
+     * Gets an array of links for the available views on this table.
+     *
+     * @since 3.1.0
+     *
+     * @global array $post_mime_types       An array of post mime types.
+     * @global array $avail_post_mime_types An array of available post mime types.
      * @return array<string, string> An array of links for the available views.
      */
@@ -199 +223 @@
 
     /**
-     * @param string $which
+     * Displays extra controls between bulk actions and pagination.
+     *
+     * @since 3.1.0
+     *
+     * @param string $which The location of the extra table nav: 'top' or 'bottom'.
      */
     protected function extra_tablenav( $which ) {
@@ -254 +282 @@
 
     /**
+     * Displays a message when no media items are found.
+     *
+     * @since 3.1.0
      */
     public function no_items() {
@@ -763 +794 @@
 
     /**
-     * @param WP_Post $post
-     * @param string  $att_title
+     * Gets the row actions for a media item.
+     *
+     * @since 3.1.0
+     *
+     * @param WP_Post $post      The current WP_Post object.
+     * @param string  $att_title The attachment title.
      * @return array<string, string> An array of row actions.
      */