Changeset 51735

Timestamp:

09/07/2021 06:18:10 PM (3 years ago)

Author:

hellofromTonya

Message:

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

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 [15632], [30679], [31210], [32740], [32753], [32754], [32755], [32756], [32757].

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

Location:

trunk/src/wp-admin/includes

Files:

• class-wp-comments-list-table.php (modified) (1 diff)
• class-wp-links-list-table.php (modified) (1 diff)
• class-wp-media-list-table.php (modified) (1 diff)
• class-wp-ms-sites-list-table.php (modified) (1 diff)
• class-wp-ms-themes-list-table.php (modified) (1 diff)
• class-wp-ms-users-list-table.php (modified) (1 diff)
• 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

@@ -869 +869 @@
 
     /**
-     * @param WP_Comment $comment The comment object.
-     */
-    public function column_cb( $comment ) {
+     * @since 5.9.0 Renamed `$comment` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @param WP_Comment $item The comment object.
+     */
+    public function column_cb( $item ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $comment = $item;
+
         if ( $this->user_can ) {
             ?>

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

@@ -167 +167 @@
      *
      * @since 4.3.0
-     *
-     * @param object $link The current link object.
-     */
-    public function column_cb( $link ) {
+     * @since 5.9.0 Renamed `$link` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @param object $item The current link object.
+     */
+    public function column_cb( $item ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $link = $item;
+
         ?>
         <label class="screen-reader-text" for="cb-select-<?php echo $link->link_id; ?>">

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

@@ -388 +388 @@
      *
      * @since 4.3.0
-     *
-     * @param WP_Post $post The current WP_Post object.
-     */
-    public function column_cb( $post ) {
+     * @since 5.9.0 Renamed `$post` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @param WP_Post $item The current WP_Post object.
+     */
+    public function column_cb( $item ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $post = $item;
+
         if ( current_user_can( 'edit_post', $post->ID ) ) {
             ?>

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

@@ -397 +397 @@
      *
      * @since 4.3.0
-     *
-     * @param array $blog Current site.
-     */
-    public function column_cb( $blog ) {
+     * @since 5.9.0 Renamed `$blog` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @param array $item Current site.
+     */
+    public function column_cb( $item ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $blog = $item;
+
         if ( ! is_main_site( $blog['blog_id'] ) ) :
             $blogname = untrailingslashit( $blog['domain'] . $blog['path'] );

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

@@ -506 +506 @@
      *
      * @since 4.3.0
-     *
-     * @param WP_Theme $theme The current WP_Theme object.
-     */
-    public function column_cb( $theme ) {
+     * @since 5.9.0 Renamed `$theme` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @param WP_Theme $item The current WP_Theme object.
+     */
+    public function column_cb( $item ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $theme       = $item;
         $checkbox_id = 'checkbox_' . md5( $theme->get( 'Name' ) );
         ?>

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

@@ -228 +228 @@
      *
      * @since 4.3.0
-     *
-     * @param WP_User $user The current WP_User object.
-     */
-    public function column_cb( $user ) {
+     * @since 5.9.0 Renamed `$user` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @param WP_User $item The current WP_User object.
+     */
+    public function column_cb( $item ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $user = $item;
+
         if ( is_super_admin( $user->ID ) ) {
             return;

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

@@ -972 +972 @@
      *
      * @since 4.3.0
-     *
-     * @param WP_Post $post The current WP_Post object.
-     */
-    public function column_cb( $post ) {
+     * @since 5.9.0 Renamed `$post` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @param WP_Post $item The current WP_Post object.
+     */
+    public function column_cb( $item ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $post = $item;
         $show = current_user_can( 'edit_post', $post->ID );
 

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

@@ -365 +365 @@
 
     /**
-     * @param WP_Term $tag Term object.
+     * @since 5.9.0 Renamed `$tag` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @param WP_Term $item Term object.
      * @return string
      */
-    public function column_cb( $tag ) {
+    public function column_cb( $item ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $tag = $item;
+
         if ( current_user_can( 'delete_term', $tag->term_id ) ) {
             return sprintf(