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

Timestamp:

01/20/2023 12:19:09 AM (21 months ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in phpunit/tests/rest-api/rest-*-controller.php.

While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit:

• Renames the $object parameter to $response_data in:
  • WP_Test_REST_Attachments_Controller::additional_field_get_callback()
  • WP_Test_REST_Autosaves_Controller::additional_field_get_callback()
  • WP_Test_REST_Categories_Controller::additional_field_get_callback()
  • WP_Test_REST_Comments_Controller::additional_field_get_callback()
  • WP_Test_REST_Post_Statuses_Controller::additional_field_get_callback()
  • WP_Test_REST_Post_Types_Controller::additional_field_get_callback()
  • WP_Test_REST_Posts_Controller::additional_field_get_callback()
  • WP_Test_REST_Revisions_Controller::additional_field_get_callback()
  • WP_Test_REST_Tags_Controller::additional_field_get_callback()
  • WP_Test_REST_Users_Controller::additional_field_get_callback()
• Amends the $data and $prepared parameters for consistency in:
  • WP_REST_Controller::add_additional_fields_to_object()
  • WP_REST_Controller::filter_response_by_context()
  • rest_filter_response_by_context()

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013], [55014], [55015], [55016], [55017], [55020], [55021], [55023], [55027], [55028], [55034], [55036], [55037], [55038], [55039], [55049], [55050], [55060], [55062], [55064], [55065], [55076], [55077], [55078], [55081], [55090], [55100].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.

File:

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

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

@@ -290 +290 @@
      * @since 4.7.0
      *
-     * @param array  $data    Response data to filter.
-     * @param string $context Context defined in the schema.
+     * @param array  $response_data Response data to filter.
+     * @param string $context       Context defined in the schema.
      * @return array Filtered response.
      */
-    public function filter_response_by_context( $data, $context ) {
+    public function filter_response_by_context( $response_data, $context ) {
 
         $schema = $this->get_item_schema();
 
-        return rest_filter_response_by_context( $data, $schema, $context );
+        return rest_filter_response_by_context( $response_data, $schema, $context );
     }
 
@@ -413 +413 @@
      * @since 4.7.0
      *
-     * @param array           $prepared Prepared response array.
-     * @param WP_REST_Request $request  Full details about the request.
+     * @param array           $response_data Prepared response array.
+     * @param WP_REST_Request $request       Full details about the request.
      * @return array Modified data object with additional fields.
      */
-    protected function add_additional_fields_to_object( $prepared, $request ) {
+    protected function add_additional_fields_to_object( $response_data, $request ) {
 
         $additional_fields = $this->get_additional_fields();
@@ -432 +432 @@
             }
 
-            $prepared[ $field_name ] = call_user_func(
+            $response_data[ $field_name ] = call_user_func(
                 $field_options['get_callback'],
-                $prepared,
+                $response_data,
                 $field_name,
                 $request,
@@ -441 +441 @@
         }
 
-        return $prepared;
+        return $response_data;
     }