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

Timestamp:

09/09/2021 12:38:36 PM (4 years ago)

Author:

hellofromTonya

Message:

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

The parent class uses $current_object_id while most of the child classes use $id. As the parent class' is more descriptive, renaming the last parameter in each of child class.

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 or misleading, 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], [51739].

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

File:

• trunk/src/wp-includes/class-walker-page.php (modified) (6 diffs)

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

@@ -94 +94 @@
      * @see Walker::start_el()
      * @since 2.1.0
-     * @since 5.9.0 Renamed `$page` 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_Post $data_object  Page data object.
-     * @param int     $depth        Optional. Depth of page. Used for padding. Default 0.
-     * @param array   $args         Optional. Array of arguments. Default empty array.
-     * @param int     $current_page Optional. Page ID. Default 0.
-     */
-    public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_page = 0 ) {
+     * @since 5.9.0 Renamed `$page` to `$data_object` and `$current_page` to `$current_object_id`
+     *              to match parent class for PHP 8 named parameter support.
+     *
+     * @param string  $output            Used to append additional content. Passed by reference.
+     * @param WP_Post $data_object       Page data object.
+     * @param int     $depth             Optional. Depth of page. Used for padding. Default 0.
+     * @param array   $args              Optional. Array of arguments. Default empty array.
+     * @param int     $current_object_id Optional. ID of the current page. Default 0.
+     */
+    public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_object_id = 0 ) {
         // Restores the more descriptive, specific name for use within this method.
-        $page = $data_object;
+        $page            = $data_object;
+        $current_page_id = $current_object_id;
 
         if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
@@ -125 +127 @@
         }
 
-        if ( ! empty( $current_page ) ) {
-            $_current_page = get_post( $current_page );
+        if ( ! empty( $current_page_id ) ) {
+            $_current_page = get_post( $current_page_id );
 
             if ( $_current_page && in_array( $page->ID, $_current_page->ancestors, true ) ) {
@@ -132 +134 @@
             }
 
-            if ( $page->ID == $current_page ) {
+            if ( $page->ID == $current_page_id ) {
                 $css_class[] = 'current_page_item';
             } elseif ( $_current_page && $page->ID === $_current_page->post_parent ) {
@@ -148 +150 @@
          * @see wp_list_pages()
          *
-         * @param string[] $css_class    An array of CSS classes to be applied to each list item.
-         * @param WP_Post  $page         Page data object.
-         * @param int      $depth        Depth of page, used for padding.
-         * @param array    $args         An array of arguments.
-         * @param int      $current_page ID of the current page.
+         * @param string[] $css_class       An array of CSS classes to be applied to each list item.
+         * @param WP_Post  $page            Page data object.
+         * @param int      $depth           Depth of page, used for padding.
+         * @param array    $args            An array of arguments.
+         * @param int      $current_page_id ID of the current page.
          */
-        $css_classes = implode( ' ', apply_filters( 'page_css_class', $css_class, $page, $depth, $args, $current_page ) );
+        $css_classes = implode( ' ', apply_filters( 'page_css_class', $css_class, $page, $depth, $args, $current_page_id ) );
         $css_classes = $css_classes ? ' class="' . esc_attr( $css_classes ) . '"' : '';
 
@@ -167 +169 @@
         $atts                 = array();
         $atts['href']         = get_permalink( $page->ID );
-        $atts['aria-current'] = ( $page->ID == $current_page ) ? 'page' : '';
+        $atts['aria-current'] = ( $page->ID == $current_page_id ) ? 'page' : '';
 
         /**
@@ -180 +182 @@
          *     @type string $aria-current The aria-current attribute.
          * }
-         * @param WP_Post $page         Page data object.
-         * @param int     $depth        Depth of page, used for padding.
-         * @param array   $args         An array of arguments.
-         * @param int     $current_page ID of the current page.
+         * @param WP_Post $page            Page data object.
+         * @param int     $depth           Depth of page, used for padding.
+         * @param array   $args            An array of arguments.
+         * @param int     $current_page_id ID of the current page.
          */
-        $atts = apply_filters( 'page_menu_link_attributes', $atts, $page, $depth, $args, $current_page );
+        $atts = apply_filters( 'page_menu_link_attributes', $atts, $page, $depth, $args, $current_page_id );
 
         $attributes = '';