WP_REST_Users_Controller
class WP_REST_Users_Controller
// Constructor: function Object() { [native code] } Core class used to manage users via the REST API.
Methods 27 methods
| Method / Return | Description |
|---|---|
| __construct() void | Constructor. |
| register_routes() void | Registers the routes for users. |
| check_reassign() (int | Checks for a valid value for the reassign parameter when deleting users.
Parameters: $value: mixed, $request: mixed, $param: mixed |
| get_items_permissions_check() (true | Permissions check for getting all users.
Parameters: $request: mixed |
| get_items() (WP_REST_Response | Retrieves all users.
Parameters: $request: mixed |
| get_user() (WP_User | Get the user, if the ID is valid.
Parameters: $id: mixed |
| get_item_permissions_check() (true | Checks if a given request has access to read a user.
Parameters: $request: mixed |
| get_item() (WP_REST_Response | Retrieves a single user.
Parameters: $request: mixed |
| get_current_item() (WP_REST_Response | Retrieves the current user.
Parameters: $request: mixed |
| create_item_permissions_check() (true | Checks if a given request has access create users.
Parameters: $request: mixed |
| create_item() (WP_REST_Response | Creates a single user.
Parameters: $request: mixed |
| update_item_permissions_check() (true | Checks if a given request has access to update a user.
Parameters: $request: mixed |
| update_item() (WP_REST_Response | Updates a single user.
Parameters: $request: mixed |
| update_current_item_permissions_check() (true | Checks if a given request has access to update the current user.
Parameters: $request: mixed |
| update_current_item() (WP_REST_Response | Updates the current user.
Parameters: $request: mixed |
| delete_item_permissions_check() (true | Checks if a given request has access delete a user.
Parameters: $request: mixed |
| delete_item() (WP_REST_Response | Deletes a single user.
Parameters: $request: mixed |
| delete_current_item_permissions_check() (true | Checks if a given request has access to delete the current user.
Parameters: $request: mixed |
| delete_current_item() (WP_REST_Response | Deletes the current user.
Parameters: $request: mixed |
| prepare_item_for_response() WP_REST_Response | Prepares a single user output for response.
Parameters: $item: mixed, $request: mixed |
| prepare_links() array | Prepares links for the user request.
Parameters: $user: mixed |
| prepare_item_for_database() object | Prepares a single user for creation or update.
Parameters: $request: mixed |
| check_role_update() (true | Determines if the current user is allowed to make the desired roles change.
Parameters: $user_id: mixed, $roles: mixed |
| check_username() (string | Check a username for the REST API.
Parameters: $value: mixed, $request: mixed, $param: mixed |
| check_user_password() (string | Check a user password for the REST API.
Parameters: $value: mixed, $request: mixed, $param: mixed |
| get_item_schema() array | Retrieves the user's schema, conforming to JSON Schema. |
| get_collection_params() array | Retrieves the query params for collections. |
Properties
| Property / Type | Description |
|---|---|
| $meta mixed public | No description available. |
| $allow_batch mixed public | No description available. |