WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Users_Controller::delete_item_permissions_check()

WP_REST_Users_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 delete a user.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

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

Source

public function delete_item_permissions_check( $request ) {
	$user = $this->get_user( $request['id'] );
	if ( is_wp_error( $user ) ) {
		return $user;
	}

	if ( ! current_user_can( 'delete_user', $user->ID ) ) {
		return new WP_Error(
			'rest_user_cannot_delete',
			__( 'Sorry, you are not allowed to delete this user.' ),
			array( 'status' => rest_authorization_required_code() )
		);
	}

	return true;
}

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Users_Controller::get_user()wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

Get the user, 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_Users_Controller::delete_current_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

Checks if a given request has access to delete the current user.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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