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-includes/class-walker-page-dropdown.php

    r51739 r51779  
    4545     *
    4646     * @since 2.1.0
    47      * @since 5.9.0 Renamed `$page` to `$data_object` to match parent class for PHP 8 named parameter support.
     47     * @since 5.9.0 Renamed `$page` to `$data_object` and `$id` to `$current_object_id`
     48     *              to match parent class for PHP 8 named parameter support.
    4849     *
    4950     * @see Walker::start_el()
    5051     *
    51      * @param string  $output      Used to append additional content. Passed by reference.
    52      * @param WP_Post $data_object Page data object.
    53      * @param int     $depth       Optional. Depth of page in reference to parent pages. Used for padding.
    54      *                             Default 0.
    55      * @param array   $args        Optional. Uses 'selected' argument for selected page to set selected HTML
    56      *                             attribute for option element. Uses 'value_field' argument to fill "value"
    57      *                             attribute. See wp_dropdown_pages(). Default empty array.
    58      * @param int     $id          Optional. ID of the current page. Default 0 (unused).
     52     * @param string  $output             Used to append additional content. Passed by reference.
     53     * @param WP_Post $data_object        Page data object.
     54     * @param int     $depth              Optional. Depth of page in reference to parent pages.
     55     *                                    Used for padding. Default 0.
     56     * @param array   $args               Optional. Uses 'selected' argument for selected page to
     57     *                                    set selected HTML attribute for option element. Uses
     58     *                                    'value_field' argument to fill "value" attribute.
     59     *                                    See wp_dropdown_pages(). Default empty array.
     60     * @param int     $current_object_id  Optional. ID of the current page. Default 0.
    5961     */
    60     public function start_el( &$output, $data_object, $depth = 0, $args = array(), $id = 0 ) {
     62    public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_object_id = 0 ) {
    6163        // Restores the more descriptive, specific name for use within this method.
    6264        $page = $data_object;
Note: See TracChangeset for help on using the changeset viewer.