W3cubDocs

/WordPress

WP_REST_Comments_Controller::update_item_permissions_check( WP_REST_Request $request )

Checks if a given REST request has access to update a comment.

Parameters

$request

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

Return

(true|WP_Error) True if the request has access to update the item, error object otherwise.

Source

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

public function update_item_permissions_check( $request ) {
		$comment = $this->get_comment( $request['id'] );
		if ( is_wp_error( $comment ) ) {
			return $comment;
		}

		if ( ! $this->check_edit_permission( $comment ) ) {
			return new WP_Error(
				'rest_cannot_edit',
				__( 'Sorry, you are not allowed to edit this comment.' ),
				array( 'status' => rest_authorization_required_code() )
			);
		}

		return true;
	}

Uses

Uses Description
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php: WP_REST_Comments_Controller::get_comment()

Get the comment, if the ID is valid.
wp-includes/rest-api.php: rest_authorization_required_code()

Returns a contextual HTTP error code for authorization failure.
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php: WP_REST_Comments_Controller::check_edit_permission()

Checks if a comment can be edited or deleted.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_comments_controller/update_item_permissions_check