Make WordPress Core


Ignore:
Timestamp:
09/08/2021 03:35:32 PM (2 years ago)
Author:
hellofromTonya
Message:

Code Modernization: Fix reserved keyword and parameter name mismatches for parent/child classes in Walker::start_el().

In the parent class, renames the parameter $object to $data_object.

Why? object is a PHP reserved keyword.

In each child class: renames the corresponding parameter to match the parent's method signature.

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.

Changes 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.
  • in cases where the original parameter name was too generic, renamed (when reassigning) to a more descriptive name for use within the method.

Follow-up to [7737], [8900], [8970], [14248], [15077], [16100], [25642], [25644], [37051], [37054], [37056], [46271], [47189].

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-walker.php

    r51204 r51739  
    8484     *
    8585     * @since 2.1.0
     86     * @since 5.9.0 Renamed `$object` (a PHP reserved keyword) to `$data_object` for PHP 8 named parameter support.
    8687     * @abstract
    8788     *
    8889     * @param string $output            Used to append additional content (passed by reference).
    89      * @param object $object            The data object.
     90     * @param object $data_object       The data object.
    9091     * @param int    $depth             Depth of the item.
    9192     * @param array  $args              An array of additional arguments.
    9293     * @param int    $current_object_id ID of the current item.
    9394     */
    94     public function start_el( &$output, $object, $depth = 0, $args = array(), $current_object_id = 0 ) {}
     95    public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_object_id = 0 ) {}
    9596
    9697    /**
Note: See TracChangeset for help on using the changeset viewer.