wppaste
WordPress

WP_REST_Server::get_max_batch_size(): int

Since
5.6.0
Source
wp-includes/rest-api/class-wp-rest-server.php:1701
Gets the maximum number of requests that can be included in a batch.

Compatibility

WordPress
since 5.6.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Return value

int
The maximum requests.

Performance profile

How much work a call to WP_REST_Server::get_max_batch_size() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
5

Executed per call on PHP 8.5. The body compiles to 5.

Plugin surface
1 hook

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

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always5apply_filters()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 5 instructions, 5 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

One hook fires while WP_REST_Server::get_max_batch_size() runs, in this order:

  1. apply_filters( rest_get_max_batch_size )filterline 1709 (+8 into the body)

    Filters the maximum number of REST API requests that can be included in a batch.

Uses · 1

  • apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

Source code

View on Trac View on GitHub 

	protected function get_max_batch_size() {		/**		 * Filters the maximum number of REST API requests that can be included in a batch.		 *		 * @since 5.6.0		 *		 * @param int $max_size The maximum size.		 */		return apply_filters( 'rest_get_max_batch_size', 25 );	}

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