WP_REST_Users_Controller

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 10

Every hook that fires from inside WP_REST_Users_Controller, in the order it appears in the class, grouped by the method that fires it.

Properties · 2

$metaWP_REST_User_Meta_Fieldsprotected

Instance of a user meta fields object.

$allow_batcharrayprotected

Whether the controller supports batching.

Methods · 27

• __construct()Constructor.
• register_routes()Registers the routes for users.
• check_reassign()Checks for a valid value for the reassign parameter when deleting users.
• get_items_permissions_check()Permissions check for getting all users.
• get_items()Retrieves all users.
• get_user()Get the user, if the ID is valid.
• get_item_permissions_check()Checks if a given request has access to read a user.
• get_item()Retrieves a single user.
• get_current_item()Retrieves the current user.
• create_item_permissions_check()Checks if a given request has access create users.
• create_item()Creates a single user.
• update_item_permissions_check()Checks if a given request has access to update a user.
• update_item()Updates a single user.
• update_current_item_permissions_check()Checks if a given request has access to update the current user.
• update_current_item()Updates the current user.
• delete_item_permissions_check()Checks if a given request has access delete a user.
• delete_item()Deletes a single user.
• delete_current_item_permissions_check()Checks if a given request has access to delete the current user.
• delete_current_item()Deletes the current user.
• prepare_item_for_response()Prepares a single user output for response.
• prepare_links()Prepares links for the user request.
• prepare_item_for_database()Prepares a single user for creation or update.
• check_role_update()Determines if the current user is allowed to make the desired roles change.
• check_username()Check a username for the REST API.
• check_user_password()Check a user password for the REST API.
• get_item_schema()Retrieves the user's schema, conforming to JSON Schema.
• get_collection_params()Retrieves the query params for collections.

Source code

View on Trac ↗View on GitHub ↗

17class WP_REST_Users_Controller extends WP_REST_Controller {18 19	/**20	 * Instance of a user meta fields object.21	 *22	 * @since 4.7.023	 * @var WP_REST_User_Meta_Fields24	 */25	protected $meta;26 27	/**28	 * Whether the controller supports batching.29	 *30	 * @since 6.6.031	 * @var array32	 */33	protected $allow_batch = array( 'v1' => true );34 35	/**36	 * Constructor.37	 *38	 * @since 4.7.039	 */40	public function __construct() {41		$this->namespace = 'wp/v2';42		$this->rest_base = 'users';43 44		$this->meta = new WP_REST_User_Meta_Fields();45	}46 47	/**48	 * Registers the routes for users.49	 *50	 * @since 4.7.051	 *52	 * @see register_rest_route()53	 */54	public function register_routes() {55 56		register_rest_route(57			$this->namespace,58			'/' . $this->rest_base,59			array(60				array(61					'methods'             => WP_REST_Server::READABLE,62					'callback'            => array( $this, 'get_items' ),63					'permission_callback' => array( $this, 'get_items_permissions_check' ),64					'args'                => $this->get_collection_params(),65				),66				array(67					'methods'             => WP_REST_Server::CREATABLE,68					'callback'            => array( $this, 'create_item' ),69					'permission_callback' => array( $this, 'create_item_permissions_check' ),70					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),71				),72				'allow_batch' => $this->allow_batch,73				'schema'      => array( $this, 'get_public_item_schema' ),74			)75		);76 77		register_rest_route(78			$this->namespace,79			'/' . $this->rest_base . '/(?P<id>[\d]+)',80			array(81				'args'        => array(82					'id' => array(83						'description' => __( 'Unique identifier for the user.' ),84						'type'        => 'integer',85					),86				),87				array(88					'methods'             => WP_REST_Server::READABLE,89					'callback'            => array( $this, 'get_item' ),90					'permission_callback' => array( $this, 'get_item_permissions_check' ),91					'args'                => array(92						'context' => $this->get_context_param( array( 'default' => 'view' ) ),93					),94				),95				array(96					'methods'             => WP_REST_Server::EDITABLE,

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.