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

Timestamp:

09/07/2021 07:23:00 PM (3 years ago)

Author:

hellofromTonya

Message:

Code Modernization: Fix parameter name mismatches for parent/child classes in WP_List_Table::handle_row_actions().

Matches the method signatures of the parent class and each child class.

Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.

For readability:

• @since clearly specifies the original parameter name and its new name as well as why the change happened

• in methods longer than a single line, the generic parameter is reassigned to the original parameter restoring it for context for use within the method. An inline comment is added to explain why this reassignment is made.

Follow-up to [32644], [32664], [32798], [38489], [49183], [49197].

Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.

File:

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

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

@@ -652 +652 @@
      *
      * @since 4.3.0
+     * @since 5.9.0 Renamed `$comment` to `$item` to match parent class for PHP 8 named parameter support.
      *
      * @global string $comment_status Status for the current listed comments.
      *
-     * @param WP_Comment $comment     The comment object.
+     * @param WP_Comment $item        The comment object.
      * @param string     $column_name Current column name.
      * @param string     $primary     Primary column name.
@@ -662 +663 @@
      *                or if the current user cannot edit the comment.
      */
-    protected function handle_row_actions( $comment, $column_name, $primary ) {
+    protected function handle_row_actions( $item, $column_name, $primary ) {
         global $comment_status;
 
@@ -673 +674 @@
         }
 
+        // Restores the more descriptive, specific name for use within this method.
+        $comment            = $item;
         $the_comment_status = wp_get_comment_status( $comment );