WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Comments_Controller::delete_item_permissions_check()

WP_REST_Comments_Controller::delete_item_permissions_check( WP_REST_Request $request ): true|WP_Error

In this article

Back to top

Checks if a given request has access to delete a comment.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

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

Source

public function delete_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_delete',
			__( 'Sorry, you are not allowed to delete this comment.' ),
			array( 'status' => rest_authorization_required_code() )
		);
	}
	return true;
}

View all references View on Trac View on GitHub

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

Get the comment, if the ID is valid.

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

Checks if a comment can be edited or deleted.

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

Returns a contextual HTTP error code for authorization failure.

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

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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