From d6afa281b614a9c457d8d0f16e596e3720d697ec Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Fri, 20 Jan 2023 00:19:09 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@55104 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/rest-api.php | 42 +++++++++---------- .../endpoints/class-wp-rest-controller.php | 20 ++++----- .../rest-api/rest-attachments-controller.php | 2 +- .../rest-api/rest-autosaves-controller.php | 4 +- .../rest-api/rest-categories-controller.php | 2 +- .../rest-api/rest-comments-controller.php | 4 +- .../rest-post-statuses-controller.php | 2 +- .../rest-api/rest-post-types-controller.php | 2 +- .../tests/rest-api/rest-posts-controller.php | 4 +- .../rest-api/rest-revisions-controller.php | 4 +- .../tests/rest-api/rest-tags-controller.php | 2 +- .../tests/rest-api/rest-users-controller.php | 4 +- 12 files changed, 46 insertions(+), 46 deletions(-) diff --git a/src/wp-includes/rest-api.php b/src/wp-includes/rest-api.php index 9898501cba..af17733265 100644 --- a/src/wp-includes/rest-api.php +++ b/src/wp-includes/rest-api.php @@ -2934,36 +2934,36 @@ function rest_parse_embed_param( $embed ) { * @since 5.6.0 Support the "patternProperties" keyword for objects. * 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'] ) ) { $schema['type'] = $matching_schema['type']; } - $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'] ) ) { $schema['type'] = $matching_schema['type']; } - $data = rest_filter_response_by_context( $data, $matching_schema, $context ); + $response_data = rest_filter_response_by_context( $response_data, $matching_schema, $context ); } } - if ( ! is_array( $data ) && ! is_object( $data ) ) { - return $data; + if ( ! is_array( $response_data ) && ! is_object( $response_data ) ) { + return $response_data; } if ( isset( $schema['type'] ) ) { @@ -2971,14 +2971,14 @@ function rest_filter_response_by_context( $data, $schema, $context ) { } elseif ( isset( $schema['properties'] ) ) { $type = 'object'; // Back compat if a developer accidentally omitted the type. } else { - return $data; + return $response_data; } $is_array_type = 'array' === $type || ( is_array( $type ) && in_array( 'array', $type, true ) ); $is_object_type = 'object' === $type || ( is_array( $type ) && in_array( 'object', $type, true ) ); if ( $is_array_type && $is_object_type ) { - if ( rest_is_array( $data ) ) { + if ( rest_is_array( $response_data ) ) { $is_object_type = false; } else { $is_array_type = false; @@ -2987,7 +2987,7 @@ function rest_filter_response_by_context( $data, $schema, $context ) { $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(); if ( $is_array_type ) { @@ -3012,27 +3012,27 @@ function rest_filter_response_by_context( $data, $schema, $context ) { if ( ! in_array( $context, $check['context'], true ) ) { 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; + $response_data[ $key ] = $new_value; } } } - return $data; + return $response_data; } /** diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php index c1de3946c0..9441aee509 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php @@ -289,15 +289,15 @@ abstract class WP_REST_Controller { * * @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 ); } /** @@ -412,11 +412,11 @@ abstract class WP_REST_Controller { * * @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(); @@ -431,16 +431,16 @@ abstract class WP_REST_Controller { continue; } - $prepared[ $field_name ] = call_user_func( + $response_data[ $field_name ] = call_user_func( $field_options['get_callback'], - $prepared, + $response_data, $field_name, $request, $this->get_object_type() ); } - return $prepared; + return $response_data; } /** diff --git a/tests/phpunit/tests/rest-api/rest-attachments-controller.php b/tests/phpunit/tests/rest-api/rest-attachments-controller.php index 0f018b0118..0a37e44a95 100644 --- a/tests/phpunit/tests/rest-api/rest-attachments-controller.php +++ b/tests/phpunit/tests/rest-api/rest-attachments-controller.php @@ -1678,7 +1678,7 @@ class WP_Test_REST_Attachments_Controller extends WP_Test_REST_Post_Type_Control $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object, $field_name ) { + public function additional_field_get_callback( $response_data, $field_name ) { return 123; } diff --git a/tests/phpunit/tests/rest-api/rest-autosaves-controller.php b/tests/phpunit/tests/rest-api/rest-autosaves-controller.php index bec3c1e578..088f02b67d 100644 --- a/tests/phpunit/tests/rest-api/rest-autosaves-controller.php +++ b/tests/phpunit/tests/rest-api/rest-autosaves-controller.php @@ -514,8 +514,8 @@ class WP_Test_REST_Autosaves_Controller extends WP_Test_REST_Post_Type_Controlle $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object, $field_name ) { - return get_post_meta( $object['id'], $field_name, true ); + public function additional_field_get_callback( $response_data, $field_name ) { + return get_post_meta( $response_data['id'], $field_name, true ); } public function additional_field_update_callback( $value, $post, $field_name ) { diff --git a/tests/phpunit/tests/rest-api/rest-categories-controller.php b/tests/phpunit/tests/rest-api/rest-categories-controller.php index b83ee7b54c..6e594afe31 100644 --- a/tests/phpunit/tests/rest-api/rest-categories-controller.php +++ b/tests/phpunit/tests/rest-api/rest-categories-controller.php @@ -1180,7 +1180,7 @@ class WP_Test_REST_Categories_Controller extends WP_Test_REST_Controller_Testcas $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object, $field_name ) { + public function additional_field_get_callback( $response_data, $field_name ) { return 123; } diff --git a/tests/phpunit/tests/rest-api/rest-comments-controller.php b/tests/phpunit/tests/rest-api/rest-comments-controller.php index 35c71ac6f6..2726ce68c9 100644 --- a/tests/phpunit/tests/rest-api/rest-comments-controller.php +++ b/tests/phpunit/tests/rest-api/rest-comments-controller.php @@ -3298,8 +3298,8 @@ class WP_Test_REST_Comments_Controller extends WP_Test_REST_Controller_Testcase $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object, $field_name ) { - return get_comment_meta( $object['id'], $field_name, true ); + public function additional_field_get_callback( $response_data, $field_name ) { + return get_comment_meta( $response_data['id'], $field_name, true ); } public function additional_field_update_callback( $value, $comment, $field_name ) { diff --git a/tests/phpunit/tests/rest-api/rest-post-statuses-controller.php b/tests/phpunit/tests/rest-api/rest-post-statuses-controller.php index 2f1e92cbae..303a94bb6e 100644 --- a/tests/phpunit/tests/rest-api/rest-post-statuses-controller.php +++ b/tests/phpunit/tests/rest-api/rest-post-statuses-controller.php @@ -200,7 +200,7 @@ class WP_Test_REST_Post_Statuses_Controller extends WP_Test_REST_Controller_Test $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object ) { + public function additional_field_get_callback( $response_data ) { return 123; } diff --git a/tests/phpunit/tests/rest-api/rest-post-types-controller.php b/tests/phpunit/tests/rest-api/rest-post-types-controller.php index a56aefa4ad..18ee7224c1 100644 --- a/tests/phpunit/tests/rest-api/rest-post-types-controller.php +++ b/tests/phpunit/tests/rest-api/rest-post-types-controller.php @@ -220,7 +220,7 @@ class WP_Test_REST_Post_Types_Controller extends WP_Test_REST_Controller_Testcas $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object ) { + public function additional_field_get_callback( $response_data ) { return 123; } diff --git a/tests/phpunit/tests/rest-api/rest-posts-controller.php b/tests/phpunit/tests/rest-api/rest-posts-controller.php index 98e2e00790..2a378c84c0 100644 --- a/tests/phpunit/tests/rest-api/rest-posts-controller.php +++ b/tests/phpunit/tests/rest-api/rest-posts-controller.php @@ -4586,8 +4586,8 @@ class WP_Test_REST_Posts_Controller extends WP_Test_REST_Post_Type_Controller_Te $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object, $field_name ) { - return get_post_meta( $object['id'], $field_name, true ); + public function additional_field_get_callback( $response_data, $field_name ) { + return get_post_meta( $response_data['id'], $field_name, true ); } public function additional_field_update_callback( $value, $post, $field_name ) { diff --git a/tests/phpunit/tests/rest-api/rest-revisions-controller.php b/tests/phpunit/tests/rest-api/rest-revisions-controller.php index 6997161281..4af746fe65 100644 --- a/tests/phpunit/tests/rest-api/rest-revisions-controller.php +++ b/tests/phpunit/tests/rest-api/rest-revisions-controller.php @@ -402,8 +402,8 @@ class WP_Test_REST_Revisions_Controller extends WP_Test_REST_Controller_Testcase $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object, $field_name ) { - return get_post_meta( $object['id'], $field_name, true ); + public function additional_field_get_callback( $response_data, $field_name ) { + return get_post_meta( $response_data['id'], $field_name, true ); } public function additional_field_update_callback( $value, $post, $field_name ) { diff --git a/tests/phpunit/tests/rest-api/rest-tags-controller.php b/tests/phpunit/tests/rest-api/rest-tags-controller.php index 6a8f29b7c1..da8f6c5878 100644 --- a/tests/phpunit/tests/rest-api/rest-tags-controller.php +++ b/tests/phpunit/tests/rest-api/rest-tags-controller.php @@ -1324,7 +1324,7 @@ class WP_Test_REST_Tags_Controller extends WP_Test_REST_Controller_Testcase { $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object, $field_name ) { + public function additional_field_get_callback( $response_data, $field_name ) { return 123; } diff --git a/tests/phpunit/tests/rest-api/rest-users-controller.php b/tests/phpunit/tests/rest-api/rest-users-controller.php index 3a1c0965b9..1187120343 100644 --- a/tests/phpunit/tests/rest-api/rest-users-controller.php +++ b/tests/phpunit/tests/rest-api/rest-users-controller.php @@ -2825,8 +2825,8 @@ class WP_Test_REST_Users_Controller extends WP_Test_REST_Controller_Testcase { $wp_rest_additional_fields = array(); } - public function additional_field_get_callback( $object, $field_name ) { - return get_user_meta( $object['id'], $field_name, true ); + public function additional_field_get_callback( $response_data, $field_name ) { + return get_user_meta( $response_data['id'], $field_name, true ); } public function additional_field_update_callback( $value, $user, $field_name ) {