WP_REST_Posts_Controller::get_item_permissions_check( WP_REST_Request $request ): bool|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

bool|WP_Error

True if the request has read access for the item, WP_Error object or false otherwise.

Performance profile

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

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

12–50

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

Plugin surface

None

Nothing here hands control to plugin code.

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 callbacksdo_action()one call below WP_REST_Posts_Controller::get_item_permissions_check()

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

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

Uses · 8

• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• rest_authorization_required_code()Returns a contextual HTTP error code for authorization failure.
• add_filter()Adds a callback function to a filter hook.
• WP_REST_Posts_Controller::get_post()Gets the post, if the ID is valid.
• WP_REST_Posts_Controller::check_update_permission()Checks if a post can be edited.
• WP_Error::__construct()Initializes the error.
• WP_REST_Posts_Controller::check_read_permission()Checks if a post can be read.

Used by · 1

• WP_REST_Menu_Items_Controller::get_item_permissions_check()Checks if a given request has access to read a menu item if they have access to edit them.

Source code

View on Trac ↗View on GitHub ↗

580	public function get_item_permissions_check( $request ) {581		$post = $this->get_post( $request['id'] );582		if ( is_wp_error( $post ) ) {583			return $post;584		}585 586		if ( 'edit' === $request['context'] && $post && ! $this->check_update_permission( $post ) ) {587			return new WP_Error(588				'rest_forbidden_context',589				__( 'Sorry, you are not allowed to edit this post.' ),590				array( 'status' => rest_authorization_required_code() )591			);592		}593 594		if ( $post && ! empty( $request->get_query_params()['password'] ) ) {595			// Check post password, and return error if invalid.596			if ( ! hash_equals( $post->post_password, $request->get_query_params()['password'] ) ) {597				return new WP_Error(598					'rest_post_incorrect_password',599					__( 'Incorrect post password.' ),600					array( 'status' => 403 )601				);602			}603		}604 605		// Allow access to all password protected posts if the context is edit.606		if ( 'edit' === $request['context'] ) {607			add_filter( 'post_password_required', array( $this, 'check_password_required' ), 10, 2 );608		}609 610		if ( $post ) {611			return $this->check_read_permission( $post );612		}613 614		return true;615	}

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