WP_REST_Controller::get_item_permissions_check() WordPress Method

The WP_REST_Controller::get_item_permissions_check() method is used to check if a given user has the permissions to perform an action on a specific item. This is typically used to check if a user has the permissions to perform an action on a specific post, but can be used for any type of item.

WP_REST_Controller::get_item_permissions_check( WP_REST_Request $request ) #

Checks if a given request has access to get a specific item.


Parameters

$request

(WP_REST_Request)(Required)Full details about the request.


Top ↑

Return

(true|WP_Error) True if the request has read access for the item, WP_Error object otherwise.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-controller.php

	public function get_item_permissions_check( $request ) {
		return new WP_Error(
			'invalid-method',
			/* translators: %s: Method name. */
			sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ),
			array( 'status' => 405 )
		);
	}


Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.