Changeset 51780 for trunk/src/wp-includes/class-wp-walker.php

Timestamp:

09/09/2021 01:02:46 PM (5 years ago)

Author:

hellofromTonya

Message:

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

In the parent class, renames the parameter $object to $data_object.
Why? object is a PHP reserved keyword. The parameter name is selected for consistency with Walker::start_el().

In each child class: renames the 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.

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

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

File:

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

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

@@ -101 +101 @@
          *
          * @since 2.1.0
+         * @since 5.9.0 Renamed `$object` (a PHP reserved keyword) to `$data_object` for PHP 8 named parameter support.
          * @abstract
          *
-         * @param string $output Used to append additional content (passed by reference).
-         * @param object $object The data object.
-         * @param int    $depth  Depth of the item.
-         * @param array  $args   An array of additional arguments.
-         */
-        public function end_el( &$output, $object, $depth = 0, $args = array() ) {}
+         * @param string $output      Used to append additional content (passed by reference).
+         * @param object $data_object The data object.
+         * @param int    $depth       Depth of the item.
+         * @param array  $args        An array of additional arguments.
+         */
+        public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {}
 
         /**