\um\commonUsers

hooks()

hooks() : mixed

Returns

filter_illegal_user_logins()

filter_illegal_user_logins(array  $usernames) : array

Integrates the "Blacklist Words" setting with the native WordPress functionality.

Parameters

Returns

map_caps_by_role()

map_caps_by_role(bool[]  $allcaps, string[]  $caps, array  $args) : bool[]

Restrict the edit/delete users via wp-admin screen due UM role capabilities

Parameters

@type string $0 Requested capability.
@type int    $1 Concerned user ID.
@type mixed  ...$2 Optional second and further parameters, typically object ID.

Returns

restrict_roles()

restrict_roles(array  $roles) : array

Hide role filters with not accessible roles

Parameters

Returns

statuses_list()

statuses_list() : array

Get the user statuses list.

Returns

set_status()

set_status(int  $user_id, string  $status) : bool

Set user's account status.

Parameters

Returns

get_status()

get_status(int  $user_id, mixed  $format = 'raw') : string

Get user account status.

Parameters

Returns

has_status()

has_status(int  $user_id, string  $status_control) : bool

Check if user has selected account status.

Parameters

Returns

remove_cache()

remove_cache(int  $user_id) : mixed

Reset User cache

Parameters

Returns

reset_activation_link()

reset_activation_link(int  $user_id) : mixed

Reset Activation link hash.

Parameters

Returns

assign_secretkey()

assign_secretkey(int  $user_id) : mixed

Set user's activation link hash

Parameters

Returns

maybe_generate_password_reset_key()

maybe_generate_password_reset_key(\WP_User  $userdata) : string|\WP_Error

Parameters

Returns

can_current_user_edit_user()

can_current_user_edit_user(int  $user_id) : bool

Parameters

Returns

can_activation_send()

can_activation_send(int  $user_id, bool  $force = false) : bool

Activation can be sent everytime for every user. Even force for current user.

Parameters

Returns

send_activation()

send_activation(int  $user_id, bool  $force = false) : bool

Parameters

Returns

can_be_deactivated()

can_be_deactivated(int  $user_id) : bool

Parameters

Returns

deactivate()

deactivate(int  $user_id) : bool

Parameters

Returns

can_be_rejected()

can_be_rejected(int  $user_id) : bool

User can be rejected only after awaiting admin review status.

Parameters

Returns

reject()

reject(int  $user_id) : bool

Reject user membership.

Parameters

Returns

can_be_set_as_pending()

can_be_set_as_pending(int  $user_id, bool  $force = false) : bool

Check if the user can be set as pending admin review. Cannot set the same status but any user can be set to pending admin review.

Parameters

Returns

set_as_pending()

set_as_pending(int  $user_id, bool  $force = false) : bool

Set user as pending admin review.

Parameters

Returns

can_be_approved()

can_be_approved(int  $user_id, bool  $force = false) : bool

Check if the user can be approved. Any user with status that isn't equal to `approved` can be approved.

Parameters

Returns

approve()

approve(int  $user_id, bool  $force = false, bool  $silent = false) : bool

Approve user.

Parameters

Returns

true if the user has been approved false on failure or if the user already has approved status.

can_be_reactivated()

can_be_reactivated(int  $user_id) : bool

Reactivated can be only `inactive` user.

Parameters

Returns

reactivate()

reactivate(int  $user_id) : bool

Reactivate user.

Parameters

Returns

true if the user has been reactivated false on failure or if the user already has approved status.

user_exists()

user_exists(int  $user_id) : bool

Parameters

Returns

destroy_all_sessions()

destroy_all_sessions(int  $user_id) : void

Clear all sessions for user ID.

Parameters

get_empty_status_users()

get_empty_status_users() : int

Retrieve the number of users with empty `account_status` usermeta.

Returns

set_last_login()

set_last_login(int  $user_id) : mixed

Set last login timestamp.

Parameters

Returns

can_view_user()

can_view_user(int  $user_id, int|null  $current_user = null) : bool

Check if the current user can view a specific user.

Parameters

Returns

True if the user can be viewed, false otherwise

get_privacy_setting()

get_privacy_setting(int  $user_id) : string|bool

Retrieve the privacy setting for a user's profile.

Parameters

Returns

The privacy setting of the user's profile, or false if the user cannot access private profile functionality.

is_user_profile_private()

is_user_profile_private(int  $user_id) : bool

Check if user profile is private based on privacy settings.

We don't handle 'account_tab_privacy' option in this function. Privacy cannot be related to the account tab visibility.

Parameters

Returns

get_restricted_privacy_notice()

get_restricted_privacy_notice(int  $user_id) : string|null

Retrieves the restricted privacy notice for a user's profile based on their privacy settings.

Parameters

Returns

Returns the restricted privacy notice text if the profile is private, or null if the profile is not private.

can_view_private_user_profile()

can_view_private_user_profile(int  $user_id, int|null  $current_user = null) : bool

Check if the current user can view a private user profile

Parameters

Returns

Whether the current user can view the private user profile

can_view_user_profile()

can_view_user_profile(int  $user_id, int|null  $current_user = null) : bool

Determine if the current user can view a specific user's profile.

Parameters

Returns

Whether the current user can view the user's profile.