WP_REST_Server::serve_batch_request_v1( WP_REST_Request $batch_request ): WP_REST_Response

Parameters

$batch_requestWP_REST_Request

The batch request object.

Return

WP_REST_Response

The generated response object.

Hooks fired · 2

2 hooks fire while WP_REST_Server::serve_batch_request_v1() runs, in this order:

1. 1
   apply_filters( rest_pre_dispatch )filterline 1840 (+125 into the body)

   Filters the pre-calculated result of a REST API dispatch request.

2. 2
   apply_filters( rest_post_dispatch )filterline 1868 (+153 into the body)

   Filters the REST API response.

Uses · 14

• wp_parse_url()A wrapper for PHP's parse_url() function that handles consistency in the return values across PHP versions.
• __()Retrieves the translation of $text.
• wp_parse_str()Parses a string into variables to be stored in an array.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_Error::__construct()Initializes the error.
• WP_REST_Request::__construct()Constructor.
• WP_REST_Server::match_request_to_handler()Matches a request object to its handler.
• WP_REST_Server::get_route_options()Retrieves specified options for a route.
• WP_REST_Server::envelope_response()Wraps the response in an envelope.
• WP_REST_Server::error_to_response()Converts an error to a response object.

Source

View on Trac ↗View on GitHub ↗

1715	public function serve_batch_request_v1( WP_REST_Request $batch_request ) {1716		$requests = array();1717 1718		foreach ( $batch_request['requests'] as $args ) {1719			$parsed_url = wp_parse_url( $args['path'] );1720 1721			if ( false === $parsed_url ) {1722				$requests[] = new WP_Error( 'parse_path_failed', __( 'Could not parse the path.' ), array( 'status' => 400 ) );1723 1724				continue;1725			}1726 1727			$single_request = new WP_REST_Request( $args['method'] ?? 'POST', $parsed_url['path'] );1728 1729			if ( ! empty( $parsed_url['query'] ) ) {1730				$query_args = array();1731				wp_parse_str( $parsed_url['query'], $query_args );1732				$single_request->set_query_params( $query_args );1733			}1734 1735			if ( ! empty( $args['body'] ) ) {1736				$single_request->set_body_params( $args['body'] );1737			}1738 1739			if ( ! empty( $args['headers'] ) ) {1740				$single_request->set_headers( $args['headers'] );1741			}1742 1743			$requests[] = $single_request;1744		}1745 1746		$matches    = array();1747		$validation = array();1748		$has_error  = false;1749 1750		foreach ( $requests as $single_request ) {1751			if ( is_wp_error( $single_request ) ) {1752				$has_error    = true;1753				$matches[]    = $single_request;1754				$validation[] = $single_request;1755				continue;1756			}1757 1758			$match     = $this->match_request_to_handler( $single_request );1759			$matches[] = $match;1760			$error     = null;1761 1762			if ( is_wp_error( $match ) ) {1763				$error = $match;1764			}1765 1766			if ( ! $error ) {1767				list( $route, $handler ) = $match;1768 1769				if ( isset( $handler['allow_batch'] ) ) {1770					$allow_batch = $handler['allow_batch'];1771				} else {1772					$route_options = $this->get_route_options( $route );1773					$allow_batch   = $route_options['allow_batch'] ?? false;1774				}1775 1776				if ( ! is_array( $allow_batch ) || empty( $allow_batch['v1'] ) ) {1777					$error = new WP_Error(1778						'rest_batch_not_allowed',1779						__( 'The requested route does not support batch requests.' ),1780						array( 'status' => 400 )1781					);1782				}1783			}1784 1785			if ( ! $error ) {1786				$check_required = $single_request->has_valid_params();1787				if ( is_wp_error( $check_required ) ) {1788					$error = $check_required;1789				}1790			}1791 1792			if ( ! $error ) {1793				$check_sanitized = $single_request->sanitize_params();1794				if ( is_wp_error( $check_sanitized ) ) {

History

Introduced in 5.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/rest-api/class-wp-rest-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.