WP_REST_Server::serve_batch_request_v1( WP_REST_Request $batch_request ): WP_REST_Response

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$batch_requestWP_REST_Request

The batch request object.

Return value

WP_REST_Response

The generated response object.

Performance profile

How much work a call to WP_REST_Server::serve_batch_request_v1() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

21–28

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 302.

Plugin surface

2 hooks

Third-party callbacks on 'rest_pre_dispatch', 'rest_post_dispatch' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Server::serve_batch_request_v1() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters 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 1866 (+125 into the body)

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

2. 2
   apply_filters( rest_post_dispatch )filterline 1894 (+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 code

View on Trac ↗View on GitHub ↗

1741	public function serve_batch_request_v1( WP_REST_Request $batch_request ) {1742		$requests = array();1743 1744		foreach ( $batch_request['requests'] as $args ) {1745			$parsed_url = wp_parse_url( $args['path'] );1746 1747			if ( false === $parsed_url ) {1748				$requests[] = new WP_Error( 'parse_path_failed', __( 'Could not parse the path.' ), array( 'status' => 400 ) );1749 1750				continue;1751			}1752 1753			$single_request = new WP_REST_Request( $args['method'] ?? 'POST', $parsed_url['path'] );1754 1755			if ( ! empty( $parsed_url['query'] ) ) {1756				$query_args = array();1757				wp_parse_str( $parsed_url['query'], $query_args );1758				$single_request->set_query_params( $query_args );1759			}1760 1761			if ( ! empty( $args['body'] ) ) {1762				$single_request->set_body_params( $args['body'] );1763			}1764 1765			if ( ! empty( $args['headers'] ) ) {1766				$single_request->set_headers( $args['headers'] );1767			}1768 1769			$requests[] = $single_request;1770		}1771 1772		$matches    = array();1773		$validation = array();1774		$has_error  = false;1775 1776		foreach ( $requests as $single_request ) {1777			if ( is_wp_error( $single_request ) ) {1778				$has_error    = true;1779				$matches[]    = $single_request;1780				$validation[] = $single_request;1781				continue;1782			}1783 1784			$match     = $this->match_request_to_handler( $single_request );1785			$matches[] = $match;1786			$error     = null;1787 1788			if ( is_wp_error( $match ) ) {1789				$error = $match;1790			}1791 1792			if ( ! $error ) {1793				list( $route, $handler ) = $match;1794 1795				if ( isset( $handler['allow_batch'] ) ) {1796					$allow_batch = $handler['allow_batch'];1797				} else {1798					$route_options = $this->get_route_options( $route );1799					$allow_batch   = $route_options['allow_batch'] ?? false;1800				}1801 1802				if ( ! is_array( $allow_batch ) || empty( $allow_batch['v1'] ) ) {1803					$error = new WP_Error(1804						'rest_batch_not_allowed',1805						__( 'The requested route does not support batch requests.' ),1806						array( 'status' => 400 )1807					);1808				}1809			}1810 1811			if ( ! $error ) {1812				$check_required = $single_request->has_valid_params();1813				if ( is_wp_error( $check_required ) ) {1814					$error = $check_required;1815				}1816			}1817 1818			if ( ! $error ) {1819				$check_sanitized = $single_request->sanitize_params();1820				if ( is_wp_error( $check_sanitized ) ) {

Changelog

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.1.0 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.