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

Timestamp:

09/09/2021 01:02:46 PM (4 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-admin/includes/class-walker-category-checklist.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";
     }