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

Timestamp:

09/07/2021 06:18:10 PM (5 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.

File:

• trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php (modified) (1 diff)

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'] );