Make WordPress Core


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

Legend:

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

    r51735 r51737  
    500500     *
    501501     * @since 4.3.0
    502      *
    503      * @param WP_User $user        User being acted upon.
     502     * @since 5.9.0 Renamed `$user` to `$item` to match parent class for PHP 8 named parameter support.
     503     *
     504     * @param WP_User $item        User being acted upon.
    504505     * @param string  $column_name Current column name.
    505506     * @param string  $primary     Primary column name.
     
    507508     *                if the current column is not the primary column.
    508509     */
    509     protected function handle_row_actions( $user, $column_name, $primary ) {
     510    protected function handle_row_actions( $item, $column_name, $primary ) {
    510511        if ( $primary !== $column_name ) {
    511512            return '';
    512513        }
    513514
     515        // Restores the more descriptive, specific name for use within this method.
     516        $user         = $item;
    514517        $super_admins = get_super_admins();
    515518
Note: See TracChangeset for help on using the changeset viewer.