Make WordPress Core


Ignore:
Timestamp:
09/08/2021 03:35:32 PM (3 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-walker-comment.php

    r50816 r51739  
    158158     *
    159159     * @since 2.7.0
     160     * @since 5.9.0 Renamed `$comment` to `$data_object` to match parent class for PHP 8 named parameter support.
    160161     *
    161162     * @see Walker::start_el()
     
    164165     * @global WP_Comment $comment       Global comment object.
    165166     *
    166      * @param string     $output  Used to append additional content. Passed by reference.
    167      * @param WP_Comment $comment Comment data object.
    168      * @param int        $depth   Optional. Depth of the current comment in reference to parents. Default 0.
    169      * @param array      $args    Optional. An array of arguments. Default empty array.
    170      * @param int        $id      Optional. ID of the current comment. Default 0 (unused).
    171      */
    172     public function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) {
     167     * @param string     $output      Used to append additional content. Passed by reference.
     168     * @param WP_Comment $data_object Comment data object.
     169     * @param int        $depth       Optional. Depth of the current comment in reference to parents. Default 0.
     170     * @param array      $args        Optional. An array of arguments. Default empty array.
     171     * @param int        $id          Optional. ID of the current comment. Default 0 (unused).
     172     */
     173    public function start_el( &$output, $data_object, $depth = 0, $args = array(), $id = 0 ) {
     174        // Restores the more descriptive, specific name for use within this method.
     175        $comment = $data_object;
     176
    173177        $depth++;
    174178        $GLOBALS['comment_depth'] = $depth;
Note: See TracChangeset for help on using the changeset viewer.