WP_REST_Revisions_Controller::get_items( WP_REST_Request $request ): WP_REST_Response|WP_Error

Compatibility

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

Parameters

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response|WP_Error

Response object on success, or WP_Error object on failure.

Performance profile

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

Heavy

Reaches the database via ->query().

Scaling

Scales with input

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

Instructions

75–194

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

Plugin surface

1 hook

Third-party callbacks on 'rest_revision_query' 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
• sqldatabase query->query()called directly

Further down the call graph this can also reach option, cache, serialize, query 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 · 34 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

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

1. 1
   apply_filters( rest_revision_query )filterline 313 (+79 into the body)

   Filters WP_Query arguments when querying revisions via the REST API.

Uses · 16

• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• wp_revisions_enabled()Determines whether revisions are enabled for a given post.
• 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).
• rest_url()Retrieves the URL to a REST endpoint.
• add_query_arg()Retrieves a modified URL query string.
• urlencode_deep()Navigates through an array, object, or scalar, and encodes the values to be used in a URL.
• WP_REST_Revisions_Controller::get_parent()Get the parent post, if the ID is valid.
• WP_Error::__construct()Initializes the error.
• WP_REST_Revisions_Controller::get_collection_params()Retrieves the query params for collections.
• WP_REST_Revisions_Controller::prepare_items_query()Determines the allowed query_vars for a get_items() response and prepares them for WP_Query.

Source code

View on Trac ↗View on GitHub ↗

234	public function get_items( $request ) {235		$parent = $this->get_parent( $request['parent'] );236		if ( is_wp_error( $parent ) ) {237			return $parent;238		}239 240		// Ensure a search string is set in case the orderby is set to 'relevance'.241		if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) ) {242			return new WP_Error(243				'rest_no_search_term_defined',244				__( 'You need to define a search term to order by relevance.' ),245				array( 'status' => 400 )246			);247		}248 249		// Ensure an include parameter is set in case the orderby is set to 'include'.250		if ( ! empty( $request['orderby'] ) && 'include' === $request['orderby'] && empty( $request['include'] ) ) {251			return new WP_Error(252				'rest_orderby_include_missing_include',253				__( 'You need to define an include parameter to order by include.' ),254				array( 'status' => 400 )255			);256		}257 258		$is_head_request = $request->is_method( 'HEAD' );259 260		if ( wp_revisions_enabled( $parent ) ) {261			$registered = $this->get_collection_params();262			$args       = array(263				'post_parent'      => $parent->ID,264				'post_type'        => 'revision',265				'post_status'      => 'inherit',266				'posts_per_page'   => -1,267				'orderby'          => 'date ID',268				'order'            => 'DESC',269				'suppress_filters' => true,270			);271 272			$parameter_mappings = array(273				'exclude'  => 'post__not_in',274				'include'  => 'post__in',275				'offset'   => 'offset',276				'order'    => 'order',277				'orderby'  => 'orderby',278				'page'     => 'paged',279				'per_page' => 'posts_per_page',280				'search'   => 's',281			);282 283			foreach ( $parameter_mappings as $api_param => $wp_param ) {284				if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {285					$args[ $wp_param ] = $request[ $api_param ];286				}287			}288 289			// For backward-compatibility, 'date' needs to resolve to 'date ID'.290			if ( isset( $args['orderby'] ) && 'date' === $args['orderby'] ) {291				$args['orderby'] = 'date ID';292			}293 294			if ( $is_head_request ) {295				// Force the 'fields' argument. For HEAD requests, only post IDs are required to calculate pagination.296				$args['fields'] = 'ids';297				// Disable priming post meta for HEAD requests to improve performance.298				$args['update_post_term_cache'] = false;299				$args['update_post_meta_cache'] = false;300			}301 302			/**303			 * Filters WP_Query arguments when querying revisions via the REST API.304			 *305			 * Serves the same purpose as the {@see 'rest_{$this->post_type}_query'} filter in306			 * WP_REST_Posts_Controller, but for the standalone WP_REST_Revisions_Controller.307			 *308			 * @since 5.0.0309			 *310			 * @param array           $args    Array of arguments for WP_Query.311			 * @param WP_REST_Request $request The REST API request.312			 */313			$args = apply_filters( 'rest_revision_query', $args, $request );

Changelog

Introduced in 4.7.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/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.