WP_REST_Users_Controller::delete_item_permissions_check() WordPress Method

The WP_REST_Users_Controller::delete_item_permissions_check() method is used to check if the current user has permission to delete the specified user. This method is called before the user is deleted, so that the correct permissions can be checked. If the user does not have permission to delete the specified user, this method will return false.

WP_REST_Users_Controller::delete_item_permissions_check( WP_REST_Request $request ) #

Checks if a given request has access delete a user.


Parameters

$request

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


Top ↑

Return

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


Top ↑

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


Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.