wppaste
WordPress

WP_REST_Block_Renderer_Controller::get_item_permissions_check( WP_REST_Request $request ): true|WP_Error

Since
5.0.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php:111
Checks if a given request has access to read blocks.

Compatibility

WordPress
since 5.0.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.

Parameters

$requestWP_REST_Request
Request.

Return value

true|WP_Error
True if the request has read access, WP_Error object otherwise.

Performance profile

How much work a call to WP_REST_Block_Renderer_Controller::get_item_permissions_check() 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 get_post().

Scaling
Constant

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

Instructions
13–34

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

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

  • querycontent queryget_post()called directly

Further down the call graph this can also reach hook, 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 · 5 distinct outcomes

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

WhenInstructionsCalls it makes
!$post_id && current_user_can()13–15current_user_can()
$post_id && current_user_can()21–23get_post(), current_user_can()
!$post_id && !current_user_can()24–26current_user_can(), __(), rest_authorization_required_code(), status()
$post_id25–27get_post(), __(), rest_authorization_required_code(), status()
$post_id && !current_user_can()32–34get_post(), current_user_can(), __(), rest_authorization_required_code(), status()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev5213–345
8.55213–345
8.45213–345
8.35213–345
8.25213–345
8.15213–3451 fewer instruction than PHP 7.4
7.45313–355

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.

Uses · 5

Source code

	public function get_item_permissions_check( $request ) {		global $post; 		$post_id = isset( $request['post_id'] ) ? (int) $request['post_id'] : 0; 		if ( $post_id > 0 ) {			$post = get_post( $post_id ); 			if ( ! $post || ! current_user_can( 'edit_post', $post->ID ) ) {				return new WP_Error(					'block_cannot_read',					__( 'Sorry, you are not allowed to read blocks of this post.' ),					array(						'status' => rest_authorization_required_code(),					)				);			}		} else {			if ( ! current_user_can( 'edit_posts' ) ) {				return new WP_Error(					'block_cannot_read',					__( 'Sorry, you are not allowed to read blocks as this user.' ),					array(						'status' => rest_authorization_required_code(),					)				);			}		} 		return true;	}

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 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-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.