User extends Component
Handles users.
Table of Contents
- __construct() : mixed
- Class constructor.
- add_admin_columns() : array<string|int, mixed>
- Adds admin columns.
- add_profile_fields() : array<string|int, mixed>
- Adds admin profile fields.
- alter_register_form() : array<string|int, mixed>
- Alters registration form.
- alter_site_footer_block() : array<string|int, mixed>
- Alters site footer block.
- login_user() : mixed
- Logins user.
- register_user() : mixed
- Registers user.
- render_admin_columns() : mixed
- Renders admin columns.
- render_user_image() : string
- Renders user image.
- update_profile_fields() : mixed
- Updates admin profile fields.
- update_user() : mixed
- Updates user.
- boot() : mixed
- Bootstraps component properties.
- set_callbacks() : mixed
- Sets the action and filter callbacks.
- set_property() : mixed
- Sets a property value.
Methods
__construct()
Class constructor.
public
__construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
-
Component arguments.
Return values
mixed —add_admin_columns()
Adds admin columns.
public
add_admin_columns(array<string|int, mixed> $columns) : array<string|int, mixed>
Parameters
- $columns : array<string|int, mixed>
-
Columns.
Return values
array<string|int, mixed> —add_profile_fields()
Adds admin profile fields.
public
add_profile_fields(array<string|int, mixed> $meta_box) : array<string|int, mixed>
Parameters
- $meta_box : array<string|int, mixed>
-
Meta box arguments.
Return values
array<string|int, mixed> —alter_register_form()
Alters registration form.
public
alter_register_form(array<string|int, mixed> $form) : array<string|int, mixed>
Parameters
- $form : array<string|int, mixed>
-
Form arguments.
Return values
array<string|int, mixed> —alter_site_footer_block()
Alters site footer block.
public
alter_site_footer_block(array<string|int, mixed> $template) : array<string|int, mixed>
Parameters
- $template : array<string|int, mixed>
-
Template arguments.
Return values
array<string|int, mixed> —login_user()
Logins user.
public
login_user(WP_User $user) : mixed
Parameters
- $user : WP_User
-
User object.
Return values
mixed —register_user()
Registers user.
public
register_user(int $user_id, array<string|int, mixed> $values) : mixed
Parameters
- $user_id : int
-
User ID.
- $values : array<string|int, mixed>
-
User values.
Return values
mixed —render_admin_columns()
Renders admin columns.
public
render_admin_columns(string $output, string $column, int $user_id) : mixed
Parameters
- $output : string
-
Output.
- $column : string
-
Column name.
- $user_id : int
-
User ID.
Return values
mixed —render_user_image()
Renders user image.
public
render_user_image(string $image, mixed $id_or_email, int $size, string $default, string $alt) : string
Parameters
- $image : string
-
Image HTML.
- $id_or_email : mixed
-
User ID.
- $size : int
-
Image size.
- $default : string
-
Default image.
- $alt : string
-
Image description.
Return values
string —update_profile_fields()
Updates admin profile fields.
public
update_profile_fields(int $user_id) : mixed
Parameters
- $user_id : int
-
User ID.
Return values
mixed —update_user()
Updates user.
public
update_user(int $user_id, object $user) : mixed
Parameters
- $user_id : int
-
User ID.
- $user : object
-
User object.
Return values
mixed —boot()
Bootstraps component properties.
protected
boot() : mixed
Return values
mixed —set_callbacks()
Sets the action and filter callbacks.
protected
final set_callbacks(array<string|int, mixed> $callbacks) : mixed
Parameters
- $callbacks : array<string|int, mixed>
-
Callback arguments.
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.