Changeset 55104 for trunk/src/wp-includes/rest-api.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.php (modified) (7 diffs)

trunk/src/wp-includes/rest-api.php

@@ -2935 +2935 @@
  *              Support the "anyOf" and "oneOf" keywords.
  *
- * @param array|object $data    The response data to modify.
- * @param array        $schema  The schema for the endpoint used to filter the response.
- * @param string       $context The requested context.
+ * @param array|object $response_data The response data to modify.
+ * @param array        $schema        The schema for the endpoint used to filter the response.
+ * @param string       $context       The requested context.
  * @return array|object The filtered response data.
  */
-function rest_filter_response_by_context( $data, $schema, $context ) {
+function rest_filter_response_by_context( $response_data, $schema, $context ) {
     if ( isset( $schema['anyOf'] ) ) {
-        $matching_schema = rest_find_any_matching_schema( $data, $schema, '' );
+        $matching_schema = rest_find_any_matching_schema( $response_data, $schema, '' );
         if ( ! is_wp_error( $matching_schema ) ) {
             if ( ! isset( $schema['type'] ) ) {
@@ -2948 +2948 @@
             }
 
-            $data = rest_filter_response_by_context( $data, $matching_schema, $context );
+            $response_data = rest_filter_response_by_context( $response_data, $matching_schema, $context );
         }
     }
 
     if ( isset( $schema['oneOf'] ) ) {
-        $matching_schema = rest_find_one_matching_schema( $data, $schema, '', true );
+        $matching_schema = rest_find_one_matching_schema( $response_data, $schema, '', true );
         if ( ! is_wp_error( $matching_schema ) ) {
             if ( ! isset( $schema['type'] ) ) {
@@ -2959 +2959 @@
             }
 
-            $data = rest_filter_response_by_context( $data, $matching_schema, $context );
-        }
-    }
-
-    if ( ! is_array( $data ) && ! is_object( $data ) ) {
-        return $data;
+            $response_data = rest_filter_response_by_context( $response_data, $matching_schema, $context );
+        }
+    }
+
+    if ( ! is_array( $response_data ) && ! is_object( $response_data ) ) {
+        return $response_data;
     }
 
@@ -2972 +2972 @@
         $type = 'object'; // Back compat if a developer accidentally omitted the type.
     } else {
-        return $data;
+        return $response_data;
     }
 
@@ -2979 +2979 @@
 
     if ( $is_array_type && $is_object_type ) {
-        if ( rest_is_array( $data ) ) {
+        if ( rest_is_array( $response_data ) ) {
             $is_object_type = false;
         } else {
@@ -2988 +2988 @@
     $has_additional_properties = $is_object_type && isset( $schema['additionalProperties'] ) && is_array( $schema['additionalProperties'] );
 
-    foreach ( $data as $key => $value ) {
+    foreach ( $response_data as $key => $value ) {
         $check = array();
 
@@ -3013 +3013 @@
             if ( $is_array_type ) {
                 // All array items share schema, so there's no need to check each one.
-                $data = array();
+                $response_data = array();
                 break;
             }
 
-            if ( is_object( $data ) ) {
-                unset( $data->$key );
+            if ( is_object( $response_data ) ) {
+                unset( $response_data->$key );
             } else {
-                unset( $data[ $key ] );
+                unset( $response_data[ $key ] );
             }
         } elseif ( is_array( $value ) || is_object( $value ) ) {
             $new_value = rest_filter_response_by_context( $value, $check, $context );
 
-            if ( is_object( $data ) ) {
-                $data->$key = $new_value;
+            if ( is_object( $response_data ) ) {
+                $response_data->$key = $new_value;
             } else {
-                $data[ $key ] = $new_value;
-            }
-        }
-    }
-
-    return $data;
+                $response_data[ $key ] = $new_value;
+            }
+        }
+    }
+
+    return $response_data;
 }