User extends Controller
Manages users.
Table of Contents
- $routes : array<string|int, mixed>
- Controller routes.
- __construct() : mixed
- Class constructor.
- delete_user() : WP_Rest_Response
- Deletes user.
- get_routes() : array<string|int, mixed>
- Gets controller routes.
- get_user_view_title() : string
- Gets user view title.
- get_users() : WP_Rest_Response
- Gets users.
- login_user() : WP_Rest_Response
- Logins user.
- redirect_user_account_page() : mixed
- Redirects user account page.
- redirect_user_edit_settings_page() : mixed
- Redirects user edit settings page.
- redirect_user_email_verify_page() : mixed
- Redirects user email verify page.
- redirect_user_login_page() : mixed
- Redirects user login page.
- redirect_user_logout_page() : mixed
- Redirects user logout page.
- redirect_user_password_reset_page() : mixed
- Redirects user password reset page.
- redirect_user_view_page() : mixed
- Redirects user view page.
- register_user() : WP_Rest_Response
- Registers user.
- render_user_edit_settings_page() : string
- Renders user edit settings page.
- render_user_email_verify_page() : string
- Renders user email verify page.
- render_user_login_page() : string
- Renders user login page.
- render_user_password_reset_page() : string
- Renders user password reset page.
- render_user_view_page() : string
- Renders user view page.
- request_user_password() : WP_Rest_Response
- Requests user password.
- reset_user_password() : WP_Rest_Response
- Resets user password.
- update_user() : WP_Rest_Response
- Updates user.
- boot() : mixed
- Bootstraps controller properties.
- set_property() : mixed
- Sets a property value.
Properties
$routes
Controller routes.
protected
array<string|int, mixed>
$routes
= []
Methods
__construct()
Class constructor.
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
-
Controller arguments.
Return values
mixed —delete_user()
Deletes user.
public
delete_user(WP_REST_Request $request) : WP_Rest_Response
Parameters
- $request : WP_REST_Request
-
API request.
Return values
WP_Rest_Response —get_routes()
Gets controller routes.
public
final get_routes() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_user_view_title()
Gets user view title.
public
get_user_view_title() : string
Return values
string —get_users()
Gets users.
public
get_users(WP_REST_Request $request) : WP_Rest_Response
Parameters
- $request : WP_REST_Request
-
API request.
Return values
WP_Rest_Response —login_user()
Logins user.
public
login_user(WP_REST_Request $request) : WP_Rest_Response
Parameters
- $request : WP_REST_Request
-
API request.
Return values
WP_Rest_Response —redirect_user_account_page()
Redirects user account page.
public
redirect_user_account_page() : mixed
Return values
mixed —redirect_user_edit_settings_page()
Redirects user edit settings page.
public
redirect_user_edit_settings_page() : mixed
Return values
mixed —redirect_user_email_verify_page()
Redirects user email verify page.
public
redirect_user_email_verify_page() : mixed
Return values
mixed —redirect_user_login_page()
Redirects user login page.
public
redirect_user_login_page() : mixed
Return values
mixed —redirect_user_logout_page()
Redirects user logout page.
public
redirect_user_logout_page() : mixed
Return values
mixed —redirect_user_password_reset_page()
Redirects user password reset page.
public
redirect_user_password_reset_page() : mixed
Return values
mixed —redirect_user_view_page()
Redirects user view page.
public
redirect_user_view_page() : mixed
Return values
mixed —register_user()
Registers user.
public
register_user(WP_REST_Request $request) : WP_Rest_Response
Parameters
- $request : WP_REST_Request
-
API request.
Return values
WP_Rest_Response —render_user_edit_settings_page()
Renders user edit settings page.
public
render_user_edit_settings_page() : string
Return values
string —render_user_email_verify_page()
Renders user email verify page.
public
render_user_email_verify_page() : string
Return values
string —render_user_login_page()
Renders user login page.
public
render_user_login_page() : string
Return values
string —render_user_password_reset_page()
Renders user password reset page.
public
render_user_password_reset_page() : string
Return values
string —render_user_view_page()
Renders user view page.
public
render_user_view_page() : string
Return values
string —request_user_password()
Requests user password.
public
request_user_password(WP_REST_Request $request) : WP_Rest_Response
Parameters
- $request : WP_REST_Request
-
API request.
Return values
WP_Rest_Response —reset_user_password()
Resets user password.
public
reset_user_password(WP_REST_Request $request) : WP_Rest_Response
Parameters
- $request : WP_REST_Request
-
API request.
Return values
WP_Rest_Response —update_user()
Updates user.
public
update_user(WP_REST_Request $request) : WP_Rest_Response
Parameters
- $request : WP_REST_Request
-
API request.
Return values
WP_Rest_Response —boot()
Bootstraps controller properties.
protected
boot() : mixed
Return values
mixed —set_property()
Sets a property value.
protected
final set_property(string $name, mixed $value[, string $prefix = '' ]) : mixed
Parameters
- $name : string
-
Property name.
- $value : mixed
-
Property value.
- $prefix : string = ''
-
Method prefix.