WordPress.org

Make WordPress Core


Ignore:
Timestamp:
09/09/2021 12:38:36 PM (6 weeks ago)
Author:
hellofromTonya
Message:

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

The parent class uses $current_object_id while most of the child classes use $id. As the parent class' is more descriptive, renaming the last parameter in each of 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.

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 or misleading, 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], [51739].

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-walker-nav-menu-checklist.php

    r51739 r51779  
    6262     *
    6363     * @since 3.0.0
    64      * @since 5.9.0 Renamed `$item` to `$data_object` to match parent class for PHP 8 named parameter support.
     64     * @since 5.9.0 Renamed `$item` to `$data_object` and `$id` to `$current_object_id`
     65     *              to match parent class for PHP 8 named parameter support.
    6566     *
    6667     * @global int        $_nav_menu_placeholder
    6768     * @global int|string $nav_menu_selected_id
    6869     *
    69      * @param string   $output      Used to append additional content (passed by reference).
    70      * @param WP_Post  $data_object Menu item data object.
    71      * @param int      $depth       Depth of menu item. Used for padding.
    72      * @param stdClass $args        Not used.
    73      * @param int      $id          Not used.
     70     * @param string   $output            Used to append additional content (passed by reference).
     71     * @param WP_Post  $data_object       Menu item data object.
     72     * @param int      $depth             Depth of menu item. Used for padding.
     73     * @param stdClass $args              Not used.
     74     * @param int      $current_object_id Optional. ID of the current menu item. Default 0.
    7475     */
    75     public function start_el( &$output, $data_object, $depth = 0, $args = null, $id = 0 ) {
     76    public function start_el( &$output, $data_object, $depth = 0, $args = null, $current_object_id = 0 ) {
    7677        global $_nav_menu_placeholder, $nav_menu_selected_id;
    7778
Note: See TracChangeset for help on using the changeset viewer.