WP_REST_Users_Controller::create_item_permissions_check() WordPress Method

The WP_REST_Users_Controller::create_item_permissions_check() method is used to check if the current user has permission to create a user. This method is called before a user is created via the REST API. If the current user does not have permission to create a user, this method will return false.

WP_REST_Users_Controller::create_item_permissions_check( WP_REST_Request $request ) #

Checks if a given request has access create users.


Parameters

$request

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


Top ↑

Return

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


Top ↑

Source

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

	public function create_item_permissions_check( $request ) {

		if ( ! current_user_can( 'create_users' ) ) {
			return new WP_Error(
				'rest_cannot_create_user',
				__( 'Sorry, you are not allowed to create new users.' ),
				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.