Changeset 51780 for trunk/src/wp-includes/class-walker-comment.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-walker-comment.php (modified) (1 diff)

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

@@ -214 +214 @@
          *
          * @since 2.7.0
+         * @since 5.9.0 Renamed `$comment` to `$data_object` to match parent class for PHP 8 named parameter support.
          *
          * @see Walker::end_el()
          * @see wp_list_comments()
          *
-         * @param string     $output  Used to append additional content. Passed by reference.
-         * @param WP_Comment $comment The current comment object. Default current comment.
-         * @param int        $depth   Optional. Depth of the current comment. Default 0.
-         * @param array      $args    Optional. An array of arguments. Default empty array.
-         */
-        public function end_el( &$output, $comment, $depth = 0, $args = array() ) {
+         * @param string     $output      Used to append additional content. Passed by reference.
+         * @param WP_Comment $data_object Comment data object.
+         * @param int        $depth       Optional. Depth of the current comment. Default 0.
+         * @param array      $args        Optional. An array of arguments. Default empty array.
+         */
+        public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
                 if ( ! empty( $args['end-callback'] ) ) {
                         ob_start();
-                        call_user_func( $args['end-callback'], $comment, $args, $depth );
+                        call_user_func(
+                                $args['end-callback'],
+                                $data_object, // The current comment object.
+                                $args,
+                                $depth
+                        );
                         $output .= ob_get_clean();
                         return;