WP_REST_Revisions_Controller::prepare_items_query( array $prepared_args = array(), WP_REST_Request $request = null ): array

Compatibility

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

Parameters

$prepared_argsarrayoptional

Prepared WP_Query arguments. Default empty array.Default: array()

$requestWP_REST_Requestoptional

Full details about the request.Default: null

Return value

array

Items query arguments.

Performance profile

How much work a call to WP_REST_Revisions_Controller::prepare_items_query() 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

8–18

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

Plugin surface

1 hook

Third-party callbacks on 'rest_query_var-{$key}' 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_Revisions_Controller::prepare_items_query() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_REST_Revisions_Controller::prepare_items_query() runs, in this order:

1. 1
   apply_filters( rest_query_var-{$key} )filterline 537 (+5 into the body)

   Filters the query_vars used in get_items() for the constructed query.

Uses · 1

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

Used by · 1

• WP_REST_Revisions_Controller::get_items()Gets a collection of revisions.

Source code

View on Trac ↗View on GitHub ↗

532	protected function prepare_items_query( $prepared_args = array(), $request = null ) {533		$query_args = array();534 535		foreach ( $prepared_args as $key => $value ) {536			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */537			$query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores538		}539 540		// Map to proper WP_Query orderby param.541		if ( isset( $query_args['orderby'] ) && isset( $request['orderby'] ) ) {542			$orderby_mappings = array(543				'id'            => 'ID',544				'include'       => 'post__in',545				'slug'          => 'post_name',546				'include_slugs' => 'post_name__in',547			);548 549			if ( isset( $orderby_mappings[ $request['orderby'] ] ) ) {550				$query_args['orderby'] = $orderby_mappings[ $request['orderby'] ];551			}552		}553 554		return $query_args;555	}

Changelog

Introduced in 5.0.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/endpoints/class-wp-rest-revisions-controller.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.