Changeset 51779 for trunk/src/wp-includes/class-walker-comment.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-comment.php (modified) (2 diffs)

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

@@ -158 +158 @@
      *
      * @since 2.7.0
-     * @since 5.9.0 Renamed `$comment` to `$data_object` to match parent class for PHP 8 named parameter support.
+     * @since 5.9.0 Renamed `$comment` to `$data_object` and `$id` to `$current_object_id`
+     *              to match parent class for PHP 8 named parameter support.
      *
      * @see Walker::start_el()
@@ -165 +166 @@
      * @global WP_Comment $comment       Global comment object.
      *
-     * @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 in reference to parents. Default 0.
-     * @param array      $args        Optional. An array of arguments. Default empty array.
-     * @param int        $id          Optional. ID of the current comment. Default 0 (unused).
-     */
-    public function start_el( &$output, $data_object, $depth = 0, $args = array(), $id = 0 ) {
+     * @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 in reference to parents. Default 0.
+     * @param array      $args              Optional. An array of arguments. Default empty array.
+     * @param int        $current_object_id Optional. ID of the current comment. 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.
         $comment = $data_object;