WP_REST_Server::serve_batch_request_v1() │ public │ WP 5.6.0

Serves the batch/v1 request.

Method of the class: WP_REST_Server{}

Return

WP_REST_Response. The generated response object.

Usage

$WP_REST_Server = new WP_REST_Server();
$WP_REST_Server->serve_batch_request_v1( $batch_request );

$batch_request(WP_REST_Request) (required)

The batch request object.

Changelog

WP_REST_Server::serve_batch_request_v1() WP REST Server::serve batch request v1 code ^{WP 6.5.2}

public function serve_batch_request_v1( WP_REST_Request $batch_request ) {
	$requests = array();

	foreach ( $batch_request['requests'] as $args ) {
		$parsed_url = wp_parse_url( $args['path'] );

		if ( false === $parsed_url ) {
			$requests[] = new WP_Error( 'parse_path_failed', __( 'Could not parse the path.' ), array( 'status' => 400 ) );

			continue;
		}

		$single_request = new WP_REST_Request( isset( $args['method'] ) ? $args['method'] : 'POST', $parsed_url['path'] );

		if ( ! empty( $parsed_url['query'] ) ) {
			$query_args = null; // Satisfy linter.
			wp_parse_str( $parsed_url['query'], $query_args );
			$single_request->set_query_params( $query_args );
		}

		if ( ! empty( $args['body'] ) ) {
			$single_request->set_body_params( $args['body'] );
		}

		if ( ! empty( $args['headers'] ) ) {
			$single_request->set_headers( $args['headers'] );
		}

		$requests[] = $single_request;
	}

	$matches    = array();
	$validation = array();
	$has_error  = false;

	foreach ( $requests as $single_request ) {
		$match     = $this->match_request_to_handler( $single_request );
		$matches[] = $match;
		$error     = null;

		if ( is_wp_error( $match ) ) {
			$error = $match;
		}

		if ( ! $error ) {
			list( $route, $handler ) = $match;

			if ( isset( $handler['allow_batch'] ) ) {
				$allow_batch = $handler['allow_batch'];
			} else {
				$route_options = $this->get_route_options( $route );
				$allow_batch   = isset( $route_options['allow_batch'] ) ? $route_options['allow_batch'] : false;
			}

			if ( ! is_array( $allow_batch ) || empty( $allow_batch['v1'] ) ) {
				$error = new WP_Error(
					'rest_batch_not_allowed',
					__( 'The requested route does not support batch requests.' ),
					array( 'status' => 400 )
				);
			}
		}

		if ( ! $error ) {
			$check_required = $single_request->has_valid_params();
			if ( is_wp_error( $check_required ) ) {
				$error = $check_required;
			}
		}

		if ( ! $error ) {
			$check_sanitized = $single_request->sanitize_params();
			if ( is_wp_error( $check_sanitized ) ) {
				$error = $check_sanitized;
			}
		}

		if ( $error ) {
			$has_error    = true;
			$validation[] = $error;
		} else {
			$validation[] = true;
		}
	}

	$responses = array();

	if ( $has_error && 'require-all-validate' === $batch_request['validation'] ) {
		foreach ( $validation as $valid ) {
			if ( is_wp_error( $valid ) ) {
				$responses[] = $this->envelope_response( $this->error_to_response( $valid ), false )->get_data();
			} else {
				$responses[] = null;
			}
		}

		return new WP_REST_Response(
			array(
				'failed'    => 'validation',
				'responses' => $responses,
			),
			WP_Http::MULTI_STATUS
		);
	}

	foreach ( $requests as $i => $single_request ) {
		$clean_request = clone $single_request;
		$clean_request->set_url_params( array() );
		$clean_request->set_attributes( array() );
		$clean_request->set_default_params( array() );

		/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
		$result = apply_filters( 'rest_pre_dispatch', null, $this, $clean_request );

		if ( empty( $result ) ) {
			$match = $matches[ $i ];
			$error = null;

			if ( is_wp_error( $validation[ $i ] ) ) {
				$error = $validation[ $i ];
			}

			if ( is_wp_error( $match ) ) {
				$result = $this->error_to_response( $match );
			} else {
				list( $route, $handler ) = $match;

				if ( ! $error && ! is_callable( $handler['callback'] ) ) {
					$error = new WP_Error(
						'rest_invalid_handler',
						__( 'The handler for the route is invalid' ),
						array( 'status' => 500 )
					);
				}

				$result = $this->respond_to_request( $single_request, $route, $handler, $error );
			}
		}

		/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
		$result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $single_request );

		$responses[] = $this->envelope_response( $result, false )->get_data();
	}

	return new WP_REST_Response( array( 'responses' => $responses ), WP_Http::MULTI_STATUS );
}