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

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 		 */
 		$result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $request );
 		// Wrap the response in an envelope if asked for.
 		if ( isset( $_GET['_envelope'] ) ) {
-			$result = $this->envelope_response( $result, isset( $_GET['_embed'] ) );
+			$embed  = isset( $_GET['_embed'] ) ? rest_parse_embed_param( $_GET['_embed'] ) : false;
+			$result = $this->envelope_response( $result, $embed );
 		}
 		// Send extra data from response objects.
 		$headers = $result->get_headers();
 		$this->send_headers( $headers );
 			$result = wp_json_encode( $result );
 			$json_error_message = $this->get_json_last_error();
 			if ( $json_error_message ) {
+				$this->set_status( 500 );
 				$json_error_obj = new WP_Error(
 					'rest_encode_error',
 					$json_error_message,
 					array( 'status' => 500 )
 				);
 	 * The enveloping technique is used to work around browser/client
 	 * compatibility issues. Essentially, it converts the full HTTP response to
 	 * data instead.
 	 *
 	 * @since 4.4.0
+	 * @since 6.0.0 The $embed parameter can now contain a list of link relations to include
 	 *
 	 * @param WP_REST_Response $response Response object.
-	 * @param bool             $embed    Whether links should be embedded.
+	 * @param bool|string[]    $embed    Whether to embed all links, a filtered list of link relations, or no links.
 	 * @return WP_REST_Response New response with wrapped data
 	 */
 	public function envelope_response( $response, $embed ) {
 		$envelope = array(
 			'body'    => $this->response_to_data( $response, $embed ),
 		 *                         `'/path/regex' => array( $callback, $bitmask )` or
 		 *                         `'/path/regex' => array( array( $callback, $bitmask ).
 		 */
 		$endpoints = apply_filters( 'rest_endpoints', $endpoints );
-		// Normalise the endpoints.
+		// Normalize the endpoints.
 		$defaults = array(
 			'methods'       => '',
 			'accept_json'   => false,
 			'accept_raw'    => false,
 			'show_in_index' => true,
 	 *
 	 * @access private
 	 * @since 5.6.0
 	 *
 	 * @param WP_REST_Request $request  The request object.
+	 * @param string          $route    The matched route regex.
 	 * @param array           $handler  The matched route handler.
-	 * @param string          $route    The matched route regex.
 	 * @param WP_Error|null   $response The current error object if any.
 	 * @return WP_REST_Response
 	 */
 	protected function respond_to_request( $request, $route, $handler, $response ) {
 		/**
 		$response = new WP_REST_Response( $available );
 		$response->add_link( 'help', 'https://developer.wordpress.org/rest-api/' );
 		$this->add_active_theme_link_to_index( $response );
 		$this->add_site_logo_to_index( $response );
+		$this->add_site_icon_to_index( $response );
 		/**
 		 * Filters the REST API root index data.
 		 *
 		 * This contains the data describing the API. This includes information
 		 * about supported authentication schemes, supported namespaces, routes
 		 * available on the API, and a small amount of data about the site.
 		 *
 		 * @since 4.4.0
+		 * @since 6.0.0 Added `$request` parameter.
 		 *
 		 * @param WP_REST_Response $response Response data.
-		 */
+		 * @param WP_REST_Request  $request  Request data.
-		return apply_filters( 'rest_index', $response );
+		 */
+		return apply_filters( 'rest_index', $response, $request );
 	}
 	/**
 	 * Adds a link to the active theme for users who have proper permissions.
 	 *
 		}
 	}
 	/**
 	 * Exposes the site logo through the WordPress REST API.
+	 *
 	 * This is used for fetching this information when user has no rights
 	 * to update settings.
 	 *
 	 * @since 5.8.0
 	 *
 	 * @param WP_REST_Response $response REST API response.
 	 */
 	protected function add_site_logo_to_index( WP_REST_Response $response ) {
-		$site_logo_id                = get_theme_mod( 'custom_logo' );
+		$site_logo_id = get_theme_mod( 'custom_logo', 0 );
-		$response->data['site_logo'] = $site_logo_id;
-		if ( $site_logo_id ) {
+		$this->add_image_to_index( $response, $site_logo_id, 'site_logo' );
+	}
+	/**
+	 * Exposes the site icon through the WordPress REST API.
+	 *
+	 * This is used for fetching this information when user has no rights
+	 * to update settings.
+	 *
+	 * @since 5.9.0
+	 *
+	 * @param WP_REST_Response $response REST API response.
+	 */
+	protected function add_site_icon_to_index( WP_REST_Response $response ) {
+		$site_icon_id = get_option( 'site_icon', 0 );
+		$this->add_image_to_index( $response, $site_icon_id, 'site_icon' );
+	}
+	/**
+	 * Exposes an image through the WordPress REST API.
+	 * This is used for fetching this information when user has no rights
+	 * to update settings.
+	 *
+	 * @since 5.9.0
+	 *
+	 * @param WP_REST_Response $response REST API response.
+	 * @param int              $image_id Image attachment ID.
+	 * @param string           $type     Type of Image.
+	 */
+	protected function add_image_to_index( WP_REST_Response $response, $image_id, $type ) {
+		$response->data[ $type ] = (int) $image_id;
+		if ( $image_id ) {
 			$response->add_link(
 				'https://api.w.org/featuredmedia',
-				rest_url( 'wp/v2/media/' . $site_logo_id ),
+				rest_url( rest_get_route_for_post( $image_id ) ),
 				array(
 					'embeddable' => true,
+					'type'       => $type,
 				)
 			);
 		}
 	}
 			if ( empty( $data ) ) {
 				continue;
 			}
 			/**
-			 * Filters the REST API endpoint data.
+			 * Filters the publicly-visible data for a single REST API route.
 			 *
 			 * @since 4.4.0
 			 *
-			 * @param WP_REST_Request $request Request data. The namespace is passed as the 'namespace' parameter.
+			 * @param array $data Publicly-visible data for the route.
 			 */
 			$available[ $route ] = apply_filters( 'rest_endpoints_description', $data );
 		}
 		/**
 			'namespace' => '',
 			'methods'   => array(),
 			'endpoints' => array(),
 		);
+		$allow_batch = false;
 		if ( isset( $this->route_options[ $route ] ) ) {
 			$options = $this->route_options[ $route ];
 			if ( isset( $options['namespace'] ) ) {
 				$data['namespace'] = $options['namespace'];
 			}
+			$allow_batch = isset( $options['allow_batch'] ) ? $options['allow_batch'] : false;
 			if ( isset( $options['schema'] ) && 'help' === $context ) {
 				$data['schema'] = call_user_func( $options['schema'] );
 			}
 		}
 			$data['methods'] = array_merge( $data['methods'], array_keys( $callback['methods'] ) );
 			$endpoint_data   = array(
 				'methods' => array_keys( $callback['methods'] ),
 			);
+			$callback_batch = isset( $callback['allow_batch'] ) ? $callback['allow_batch'] : $allow_batch;
+			if ( $callback_batch ) {
+				$endpoint_data['allow_batch'] = $callback_batch;
+			}
 			if ( isset( $callback['args'] ) ) {
 				$endpoint_data['args'] = array();
 				foreach ( $callback['args'] as $key => $opts ) {

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6