Users extends Base_Route implements Route
REST controller for handling user operations.
Tags
Interfaces, Classes and Traits
- Route
Table of Contents
- $rest_base : mixed
- get_preloaded_users() : WP_REST_Response|WP_Error
- Get preloaded users.
- get_users() : WP_REST_Response|WP_Error
- Get users based on search term.
- permission_callback() : bool
- Permission callback.
- register_routes() : mixed
- Register the REST routes.
Properties
$rest_base
protected
mixed
$rest_base
= 'users'
Tags
Methods
get_preloaded_users()
Get preloaded users.
public
get_preloaded_users(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
Tags
Return values
WP_REST_Response|WP_Error —get_users()
Get users based on search term.
public
get_users(WP_REST_Request $request) : WP_REST_Response|WP_Error
Parameters
- $request : WP_REST_Request
Tags
Return values
WP_REST_Response|WP_Error —permission_callback()
Permission callback.
public
permission_callback() : bool
Tags
Return values
bool —register_routes()
Register the REST routes.
public
register_routes() : mixed