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

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 1829 (+112 into the body)

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

2. 2
   apply_filters( rest_post_dispatch )filterline 1857 (+140 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 ↗

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

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