Make WordPress Core


Ignore:
Timestamp:
09/02/2021 10:25:58 PM (3 years ago)
Author:
hellofromTonya
Message:

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

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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php

    r49197 r51728  
    561561     *
    562562     * @since 4.3.0
    563      *
    564      * @param array  $blog        Current site.
     563     * @since 5.9.0 Renamed `$blog` to `$item` to match parent class for PHP 8 named param.
     564     *
     565     * @param array  $item        Current site.
    565566     * @param string $column_name Current column name.
    566567     */
    567     public function column_default( $blog, $column_name ) {
     568    public function column_default( $item, $column_name ) {
    568569        /**
    569570         * Fires for each registered custom column in the Sites list table.
     
    574575         * @param int    $blog_id     The site ID.
    575576         */
    576         do_action( 'manage_sites_custom_column', $column_name, $blog['blog_id'] );
     577        do_action( 'manage_sites_custom_column', $column_name, $item['blog_id'] );
    577578    }
    578579
Note: See TracChangeset for help on using the changeset viewer.