Changeset 51779 for trunk/src/wp-includes/class-walker-nav-menu.php

Timestamp:

09/09/2021 12:38:36 PM (3 years 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:

• trunk/src/wp-includes/class-walker-nav-menu.php (modified) (1 diff)

trunk/src/wp-includes/class-walker-nav-menu.php

@@ -107 +107 @@
      * @since 3.0.0
      * @since 4.4.0 The {@see 'nav_menu_item_args'} filter was added.
-     * @since 5.9.0 Renamed `$item` to `$data_object` to match parent class for PHP 8 named parameter support.
+     * @since 5.9.0 Renamed `$item` to `$data_object` and `$id` to `$current_object_id`
+     *              to match parent class for PHP 8 named parameter support.
      *
      * @see Walker::start_el()
      *
-     * @param string   $output      Used to append additional content (passed by reference).
-     * @param WP_Post  $data_object Menu item data object.
-     * @param int      $depth       Depth of menu item. Used for padding.
-     * @param stdClass $args        An object of wp_nav_menu() arguments.
-     * @param int      $id          Current item ID.
-     */
-    public function start_el( &$output, $data_object, $depth = 0, $args = null, $id = 0 ) {
+     * @param string   $output            Used to append additional content (passed by reference).
+     * @param WP_Post  $data_object       Menu item data object.
+     * @param int      $depth             Depth of menu item. Used for padding.
+     * @param stdClass $args              An object of wp_nav_menu() arguments.
+     * @param int      $current_object_id Optional. ID of the current menu item. Default 0.
+     */
+    public function start_el( &$output, $data_object, $depth = 0, $args = null, $current_object_id = 0 ) {
         // Restores the more descriptive, specific name for use within this method.
         $menu_item = $data_object;