RUA_User_Interface
in
Table of Contents
- add_level() : bool
- get_attribute() : mixed|null
- Get any attribute from underlying WP_User
- get_caps() : array<string|int, mixed>
- Get all user capabilities, based on level memberships
- get_id() : int
- get_level_expiry() : int
- get_level_ids() : array<string|int, int>
- Get ids of all levels user is active member of, directly or indirectly
- get_level_start() : int
- has_global_access() : bool
- has_level() : bool
- Check if user has active membership of level, not including indirect memberships
- is_level_expired() : bool
- level_memberships() : RUA_Collection<string|int, RUA_User_Level_Interface>|array<string|int, RUA_User_Level_Interface>
- Get all level memberships, including inactive
- remove_level() : bool
Methods
add_level()
public
add_level(int $level_id) : bool
Parameters
- $level_id : int
Tags
Return values
bool —get_attribute()
Get any attribute from underlying WP_User
public
get_attribute(string $name[, mixed|null $default_value = null ]) : mixed|null
Parameters
- $name : string
- $default_value : mixed|null = null
Tags
Return values
mixed|null —get_caps()
Get all user capabilities, based on level memberships
public
get_caps([array<string|int, mixed> $current_caps = [] ]) : array<string|int, mixed>
Parameters
- $current_caps : array<string|int, mixed> = []
-
(optional preset)
Tags
Return values
array<string|int, mixed> —get_id()
public
get_id() : int
Tags
Return values
int —get_level_expiry()
public
get_level_expiry(int $level_id) : int
Parameters
- $level_id : int
Tags
Return values
int —get_level_ids()
Get ids of all levels user is active member of, directly or indirectly
public
get_level_ids([bool $hierarchical = true ][, bool $synced_roles = true ][, bool $include_expired = false ]) : array<string|int, int>
Parameters
- $hierarchical : bool = true
-
- deprecated
- $synced_roles : bool = true
-
- deprecated
- $include_expired : bool = false
-
- deprecated
Tags
Return values
array<string|int, int> —get_level_start()
public
get_level_start(int $level_id) : int
Parameters
- $level_id : int
Tags
Return values
int —has_global_access()
public
has_global_access() : bool
Tags
Return values
bool —has_level()
Check if user has active membership of level, not including indirect memberships
public
has_level(int $level_id) : bool
Parameters
- $level_id : int
Tags
Return values
bool —is_level_expired()
public
is_level_expired(int $level_id) : bool
Parameters
- $level_id : int
Tags
Return values
bool —level_memberships()
Get all level memberships, including inactive
public
level_memberships() : RUA_Collection<string|int, RUA_User_Level_Interface>|array<string|int, RUA_User_Level_Interface>
Tags
Return values
RUA_Collection<string|int, RUA_User_Level_Interface>|array<string|int, RUA_User_Level_Interface> —remove_level()
public
remove_level(int $level_id) : bool
Parameters
- $level_id : int