WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Terms_Controller::get_item_permissions_check()

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

In this article

Back to top

Checks if a request has access to read or edit the specified term.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

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

Source

public function get_item_permissions_check( $request ) {
	$term = $this->get_term( $request['id'] );

	if ( is_wp_error( $term ) ) {
		return $term;
	}

	if ( 'edit' === $request['context'] && ! current_user_can( 'edit_term', $term->term_id ) ) {
		return new WP_Error(
			'rest_forbidden_context',
			__( 'Sorry, you are not allowed to edit this term.' ),
			array( 'status' => rest_authorization_required_code() )
		);
	}

	return true;
}

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Terms_Controller::get_term()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Get the term, if the ID is valid.

rest_authorization_required_code()wp-includes/rest-api.php

Returns a contextual HTTP error code for authorization failure.

current_user_can()wp-includes/capabilities.php

Returns whether the current user has the specified capability.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 3 moreShow less
Used byDescription
WP_REST_Menus_Controller::get_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php

Checks if a request has access to read or edit the specified menu.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.