Changeset 51786 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

Timestamp:

09/09/2021 06:35:34 PM (3 years ago)

Author:

hellofromTonya

Message:

Code Modernization: Fix parameter name mismatches for parent/child classes in WP_REST_Controller::prepare_item_for_response().

In each child and grandchild class, renames the first 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.

Follow-up to [38832], [39011], [39015], [39021], [39024], [39025], [39031], [39036], [43519], [43735], [43739], [43768], [46821], [48173], [48242], [49088], [50995], [51003], [51021].

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

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php (modified) (3 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

@@ -187 +187 @@
      * @since 5.0.0
      * @since 5.6.0 The `$id` parameter can accept a string.
-     *
-     * @param int|string      $id      ID of the item to prepare.
+     * @since 5.9.0 Renamed `$id` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @param int|string      $item    ID of the item to prepare.
      * @param WP_REST_Request $request Request object.
      * @return WP_REST_Response Response object.
      */
-    public function prepare_item_for_response( $id, $request ) {
+    public function prepare_item_for_response( $item, $request ) {
+        // Restores the more descriptive, specific name for use within this method.
+        $item_id = $item;
         $handler = $this->get_search_handler( $request );
         if ( is_wp_error( $handler ) ) {
@@ -200 +203 @@
         $fields = $this->get_fields_for_response( $request );
 
-        $data = $handler->prepare_item( $id, $fields );
+        $data = $handler->prepare_item( $item_id, $fields );
         $data = $this->add_additional_fields_to_object( $data, $request );
 
@@ -208 +211 @@
         $response = rest_ensure_response( $data );
 
-        $links               = $handler->prepare_item_links( $id );
+        $links               = $handler->prepare_item_links( $item_id );
         $links['collection'] = array(
             'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),