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

Timestamp:

09/08/2021 03:35:32 PM (3 years ago)

Author:

hellofromTonya

Message:

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

In the parent class, renames the parameter $object to $data_object.

Why? object is a PHP reserved keyword.

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

• 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, 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].

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

File:

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

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

@@ -87 +87 @@
      *
      * @since 2.1.0
+     * @since 5.9.0 Renamed `$category` to `$data_object` 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_Term $category Category data object.
-     * @param int     $depth    Optional. Depth of category in reference to parents. Default 0.
-     * @param array   $args     Optional. An array of arguments. See wp_list_categories(). Default empty array.
-     * @param int     $id       Optional. ID of the current category. Default 0.
-     */
-    public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
+     * @param string  $output      Used to append additional content (passed by reference).
+     * @param WP_Term $data_object Category data object.
+     * @param int     $depth       Optional. Depth of category in reference to parents. Default 0.
+     * @param array   $args        Optional. An array of arguments. See wp_list_categories().
+     *                             Default empty array.
+     * @param int     $id          Optional. ID of the current category. Default 0.
+     */
+    public function start_el( &$output, $data_object, $depth = 0, $args = array(), $id = 0 ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $category = $data_object;
+
         /** This filter is documented in wp-includes/category-template.php */
         $cat_name = apply_filters( 'list_cats', esc_attr( $category->name ), $category );