enmi-conf.org: comparison wp/wp-includes/rest-api/endpoints/class-wp-rest-controller.php

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 /**
 * Core base controller for managing and interacting with REST API items.
 *
 * @since 4.7.0
 */
+#[AllowDynamicProperties]
 abstract class WP_REST_Controller {
 	/**
 	 * The namespace of this controller's route.
 	 *
 	/**
 	 * Filters a response based on the context defined in the schema.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @param array  $data    Response data to filter.
+	 * @param array  $response_data Response data to filter.
-	 * @param string $context Context defined in the schema.
+	 * @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 );
 	}
 	/**
 	 * Retrieves the item's schema, conforming to JSON Schema.
 	 *
 	/**
 	 * Adds the values from additional fields to a data object.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @param array           $prepared Prepared response array.
+	 * @param array           $response_data Prepared response array.
-	 * @param WP_REST_Request $request  Full details about the request.
+	 * @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();
 		$requested_fields = $this->get_fields_for_response( $request );
 			if ( ! rest_is_field_included( $field_name, $requested_fields ) ) {
 				continue;
 			}
-			$prepared[ $field_name ] = call_user_func( $field_options['get_callback'], $prepared, $field_name, $request, $this->get_object_type() );
+			$response_data[ $field_name ] = call_user_func(
-		}
+				$field_options['get_callback'],
+				$response_data,
-		return $prepared;
+				$field_name,
+				$request,
+				$this->get_object_type()
+			);
+		}
+		return $response_data;
 	}
 	/**
 	 * Updates the values of additional fields added to a data object.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @param object          $object  Data model like WP_Term or WP_Post.
+	 * @param object          $data_object Data model like WP_Term or WP_Post.
-	 * @param WP_REST_Request $request Full details about the request.
+	 * @param WP_REST_Request $request     Full details about the request.
 	 * @return true|WP_Error True on success, WP_Error object if a field cannot be updated.
 	 */
-	protected function update_additional_fields_for_object( $object, $request ) {
+	protected function update_additional_fields_for_object( $data_object, $request ) {
 		$additional_fields = $this->get_additional_fields();
 		foreach ( $additional_fields as $field_name => $field_options ) {
 			if ( ! $field_options['update_callback'] ) {
 				continue;
 			// Don't run the update callbacks if the data wasn't passed in the request.
 			if ( ! isset( $request[ $field_name ] ) ) {
 				continue;
 			}
-			$result = call_user_func( $field_options['update_callback'], $request[ $field_name ], $object, $field_name, $request, $this->get_object_type() );
+			$result = call_user_func(
+				$field_options['update_callback'],
+				$request[ $field_name ],
+				$data_object,
+				$field_name,
+				$request,
+				$this->get_object_type()
+			);
 			if ( is_wp_error( $result ) ) {
 				return $result;
 			}
 		}
 		$properties = isset( $schema['properties'] ) ? $schema['properties'] : array();
 		$additional_fields = $this->get_additional_fields();
 		foreach ( $additional_fields as $field_name => $field_options ) {
-			// For back-compat, include any field with an empty schema
+			/*
-			// because it won't be present in $this->get_item_schema().
+			 * For back-compat, include any field with an empty schema
+			 * because it won't be present in $this->get_item_schema().
+			 */
 			if ( is_null( $field_options['schema'] ) ) {
 				$properties[ $field_name ] = $field_options;
 			}
 		}
 			}
 		}
 		$fields = array_keys( $properties );
+		/*
+		 * '_links' and '_embedded' are not typically part of the item schema,
+		 * but they can be specified in '_fields', so they are added here as a
+		 * convenience for checking with rest_is_field_included().
+		 */
+		$fields[] = '_links';
+		if ( $request->has_param( '_embed' ) ) {
+			$fields[] = '_embedded';
+		}
+		$fields = array_unique( $fields );
 		if ( ! isset( $request['_fields'] ) ) {
 			return $fields;
 		}
 		$requested_fields = wp_parse_list( $request['_fields'] );
 		if ( 0 === count( $requested_fields ) ) {
 			$requested_fields[] = 'id';
 		}
 		// Return the list of all requested fields which appear in the schema.
 		return array_reduce(
 			$requested_fields,
-			static function( $response_fields, $field ) use ( $fields ) {
+			static function ( $response_fields, $field ) use ( $fields ) {
 				if ( in_array( $field, $fields, true ) ) {
 					$response_fields[] = $field;
 					return $response_fields;
 				}
 				// Check for nested fields if $field is not a direct match.
 				$nested_fields = explode( '.', $field );
-				// A nested field is included so long as its top-level property
+				/*
-				// is present in the schema.
+				 * A nested field is included so long as its top-level property
+				 * is present in the schema.
+				 */
 				if ( in_array( $nested_fields[0], $fields, true ) ) {
 					$response_fields[] = $field;
 				}
 				return $response_fields;
 			},

changeset 21	48c4eec2b7e6
parent 19	3d72ae0968f4