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

Description

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

The request instance.

Return value

WP_REST_Response|WP_Error

Performance profile

How much work a call to WP_REST_Global_Styles_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

81–186

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• sqldatabase query->query()called directly
• hookthird-party callbacksdo_action()one call below WP_REST_Global_Styles_Revisions_Controller::get_items()

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

Uses · 15

• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_revisions_enabled()Determines whether revisions are enabled for a given post.
• __()Retrieves the translation of $text.
• 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_Global_Styles_Revisions_Controller::get_parent()
• WP_REST_Global_Styles_Revisions_Controller::get_decoded_global_styles_json()Returns decoded JSON from post content string, or a 404 if not found.
• WP_REST_Global_Styles_Revisions_Controller::get_collection_params()Retrieves the query params for collections.
• WP_Query::__construct()Constructor.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

153	public function get_items( $request ) {154		$parent = $this->get_parent( $request['parent'] );155 156		if ( is_wp_error( $parent ) ) {157			return $parent;158		}159 160		$global_styles_config = $this->get_decoded_global_styles_json( $parent->post_content );161 162		if ( is_wp_error( $global_styles_config ) ) {163			return $global_styles_config;164		}165 166		$is_head_request = $request->is_method( 'HEAD' );167 168		if ( wp_revisions_enabled( $parent ) ) {169			$registered = $this->get_collection_params();170			$query_args = array(171				'post_parent'    => $parent->ID,172				'post_type'      => 'revision',173				'post_status'    => 'inherit',174				'posts_per_page' => -1,175				'orderby'        => 'date ID',176				'order'          => 'DESC',177			);178 179			$parameter_mappings = array(180				'offset'   => 'offset',181				'page'     => 'paged',182				'per_page' => 'posts_per_page',183			);184 185			foreach ( $parameter_mappings as $api_param => $wp_param ) {186				if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {187					$query_args[ $wp_param ] = $request[ $api_param ];188				}189			}190 191			if ( $is_head_request ) {192				// Force the 'fields' argument. For HEAD requests, only post IDs are required to calculate pagination.193				$query_args['fields'] = 'ids';194				// Disable priming post meta for HEAD requests to improve performance.195				$query_args['update_post_term_cache'] = false;196				$query_args['update_post_meta_cache'] = false;197			}198 199			$revisions_query = new WP_Query();200			$revisions       = $revisions_query->query( $query_args );201			$offset          = isset( $query_args['offset'] ) ? (int) $query_args['offset'] : 0;202			$page            = isset( $query_args['paged'] ) ? (int) $query_args['paged'] : 0;203			$total_revisions = $revisions_query->found_posts;204 205			if ( $total_revisions < 1 ) {206				// Out-of-bounds, run the query without pagination/offset to get the total count.207				unset( $query_args['paged'], $query_args['offset'] );208 209				$count_query                          = new WP_Query();210				$query_args['fields']                 = 'ids';211				$query_args['posts_per_page']         = 1;212				$query_args['update_post_meta_cache'] = false;213				$query_args['update_post_term_cache'] = false;214 215				$count_query->query( $query_args );216 217				$total_revisions = $count_query->found_posts;218			}219 220			if ( $revisions_query->query_vars['posts_per_page'] > 0 ) {221				$max_pages = (int) ceil( $total_revisions / (int) $revisions_query->query_vars['posts_per_page'] );222			} else {223				$max_pages = $total_revisions > 0 ? 1 : 0;224			}225			if ( $total_revisions > 0 ) {226				if ( $offset >= $total_revisions ) {227					return new WP_Error(228						'rest_revision_invalid_offset_number',229						__( 'The offset number requested is larger than or equal to the number of available revisions.' ),230						array( 'status' => 400 )231					);232				} elseif ( ! $offset && $page > $max_pages ) {

Changelog

Introduced in 6.3.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/endpoints/class-wp-rest-global-styles-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.