Changeset 47059

Timestamp:

01/11/2020 05:56:15 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Synchronize @return descriptions for ::handle_row_actions() methods in list tables.

Make sure WP_Comments_List_Table::handle_row_actions() and WP_MS_Sites_List_Table::handle_row_actions() return a string, for consistency with other classes.

See #49170, #48303.

Location:

trunk/src/wp-admin/includes

Files:

• class-wp-comments-list-table.php (modified) (2 diffs)
• class-wp-links-list-table.php (modified) (1 diff)
• class-wp-media-list-table.php (modified) (2 diffs)
• class-wp-ms-sites-list-table.php (modified) (2 diffs)
• class-wp-ms-users-list-table.php (modified) (2 diffs)
• class-wp-posts-list-table.php (modified) (1 diff)
• class-wp-terms-list-table.php (modified) (1 diff)

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

@@ -577 +577 @@
      * @param string     $column_name Current column name.
      * @param string     $primary     Primary column name.
-     * @return string|void Comment row actions output.
+     * @return string Row actions output for comments. An empty string
+     *                if the current column is not the primary column,
+     *                or if the current user cannot edit the comment.
      */
     protected function handle_row_actions( $comment, $column_name, $primary ) {
@@ -587 +589 @@
 
         if ( ! $this->user_can ) {
-            return;
+            return '';
         }
 

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

@@ -315 +315 @@
      * @param string $column_name Current column name.
      * @param string $primary     Primary column name.
-     * @return string Row action output for links.
+     * @return string Row actions output for links, or an empty string
+     *                if the current column is not the primary column.
      */
     protected function handle_row_actions( $link, $column_name, $primary ) {

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

@@ -782 +782 @@
      * @param string $column_name Current column name.
      * @param string $primary     Primary column name.
-     * @return string Row actions output for media attachments.
+     * @return string Row actions output for media attachments, or an empty string
+     *                if the current column is not the primary column.
      */
     protected function handle_row_actions( $post, $column_name, $primary ) {
@@ -790 +791 @@
 
         $att_title = _draft_or_post_title();
+
         return $this->row_actions( $this->_get_row_actions( $post, $att_title ) );
     }

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

@@ -667 +667 @@
      * @param string $column_name Current column name.
      * @param string $primary     Primary column name.
-     * @return string Row actions output.
+     * @return string Row actions output for sites in Multisite, or an empty string
+     *                if the current column is not the primary column.
      */
     protected function handle_row_actions( $blog, $column_name, $primary ) {
         if ( $primary !== $column_name ) {
-            return;
+            return '';
         }
 
@@ -734 +735 @@
          */
         $actions = apply_filters( 'manage_sites_action_links', array_filter( $actions ), $blog['blog_id'], $blogname );
+
         return $this->row_actions( $actions );
     }

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

@@ -489 +489 @@
      * @param string $column_name Current column name.
      * @param string $primary     Primary column name.
-     * @return string Row actions output for users in Multisite.
+     * @return string Row actions output for users in Multisite, or an empty string
+     *                if the current column is not the primary column.
      */
     protected function handle_row_actions( $user, $column_name, $primary ) {
@@ -518 +519 @@
          */
         $actions = apply_filters( 'ms_user_row_actions', $actions, $user );
+
         return $this->row_actions( $actions );
     }

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

@@ -1321 +1321 @@
      * @param string $column_name Current column name.
      * @param string $primary     Primary column name.
-     * @return string Row actions output for posts.
+     * @return string Row actions output for posts, or an empty string
+     *                if the current column is not the primary column.
      */
     protected function handle_row_actions( $post, $column_name, $primary ) {

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

@@ -447 +447 @@
      * @param string  $column_name Current column name.
      * @param string  $primary     Primary column name.
-     * @return string Row actions output for terms.
+     * @return string Row actions output for terms, or an empty string
+     *                if the current column is not the primary column.
      */
     protected function handle_row_actions( $tag, $column_name, $primary ) {