WP_REST_Users_Controller::delete_item_permissions_check

Advertisement

Summery Summery

Checks if a given request has access delete a user.

Syntax Syntax

WP_REST_Users_Controller::delete_item_permissions_check( WP_REST_Request $request )

Parameters Parameters

$request

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

Return Return

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

Source Source

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

	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;
	}

Advertisement

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

What are you looking for?