Changeset 51780

Timestamp:

09/09/2021 01:02:46 PM (3 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.

Location:

trunk/src

Files:

• wp-admin/includes/class-walker-category-checklist.php (modified) (1 diff)
• wp-includes/class-walker-category.php (modified) (1 diff)
• wp-includes/class-walker-comment.php (modified) (1 diff)
• wp-includes/class-walker-nav-menu.php (modified) (1 diff)
• wp-includes/class-walker-page.php (modified) (1 diff)
• wp-includes/class-wp-walker.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-walker-category-checklist.php

@@ -126 +126 @@
      *
      * @since 2.5.1
+     * @since 5.9.0 Renamed `$category` to `$data_object` to match parent class for PHP 8 named parameter support.
      *
-     * @param string  $output   Used to append additional content (passed by reference).
-     * @param WP_Term $category The current term object.
-     * @param int     $depth    Depth of the term in reference to parents. Default 0.
-     * @param array   $args     An array of arguments. @see wp_terms_checklist()
+     * @param string  $output      Used to append additional content (passed by reference).
+     * @param WP_Term $data_object The current term object.
+     * @param int     $depth       Depth of the term in reference to parents. Default 0.
+     * @param array   $args        An array of arguments. @see wp_terms_checklist()
      */
-    public function end_el( &$output, $category, $depth = 0, $args = array() ) {
+    public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
         $output .= "</li>\n";
     }

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

@@ -255 +255 @@
      *
      * @since 2.1.0
+     * @since 5.9.0 Renamed `$page` to `$data_object` to match parent class for PHP 8 named parameter support.
      *
      * @see Walker::end_el()
      *
-     * @param string $output Used to append additional content (passed by reference).
-     * @param object $page   Not used.
-     * @param int    $depth  Optional. Depth of category. Not used.
-     * @param array  $args   Optional. An array of arguments. Only uses 'list' for whether should append
-     *                       to output. See wp_list_categories(). Default empty array.
-     */
-    public function end_el( &$output, $page, $depth = 0, $args = array() ) {
+     * @param string $output      Used to append additional content (passed by reference).
+     * @param object $data_object Category data object. Not used.
+     * @param int    $depth       Optional. Depth of category. Not used.
+     * @param array  $args        Optional. An array of arguments. Only uses 'list' for whether should
+     *                            append to output. See wp_list_categories(). Default empty array.
+     */
+    public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
         if ( 'list' !== $args['style'] ) {
             return;

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;

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

@@ -257 +257 @@
      *
      * @since 3.0.0
+     * @since 5.9.0 Renamed `$item` to `$data_object` to match parent class for PHP 8 named parameter support.
      *
      * @see Walker::end_el()
      *
-     * @param string   $output Used to append additional content (passed by reference).
-     * @param WP_Post  $item   Page data object. Not used.
-     * @param int      $depth  Depth of page. Not Used.
-     * @param stdClass $args   An object of wp_nav_menu() arguments.
-     */
-    public function end_el( &$output, $item, $depth = 0, $args = null ) {
+     * @param string   $output      Used to append additional content (passed by reference).
+     * @param WP_Post  $data_object Menu item data object. Not used.
+     * @param int      $depth       Depth of page. Not Used.
+     * @param stdClass $args        An object of wp_nav_menu() arguments.
+     */
+    public function end_el( &$output, $data_object, $depth = 0, $args = null ) {
         if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) {
             $t = '';

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

@@ -223 +223 @@
      *
      * @since 2.1.0
+     * @since 5.9.0 Renamed `$page` to `$data_object` to match parent class for PHP 8 named parameter support.
      *
      * @see Walker::end_el()
      *
-     * @param string  $output Used to append additional content. Passed by reference.
-     * @param WP_Post $page   Page data object. Not used.
-     * @param int     $depth  Optional. Depth of page. Default 0 (unused).
-     * @param array   $args   Optional. Array of arguments. Default empty array.
-     */
-    public function end_el( &$output, $page, $depth = 0, $args = array() ) {
+     * @param string  $output      Used to append additional content. Passed by reference.
+     * @param WP_Post $data_object Page data object. Not used.
+     * @param int     $depth       Optional. Depth of page. Default 0 (unused).
+     * @param array   $args        Optional. Array of arguments. Default empty array.
+     */
+    public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
         if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
             $t = "\t";

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() ) {}
 
     /**