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

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.

File:

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

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 '';
         }