Restrict User Access

RUA_User_Interface

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
since
1.1
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
since
2.1
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
since
1.1
Return values
array<string|int, mixed>

get_id()

public get_id() : int
Tags
since
1.1
Return values
int

get_level_expiry()

public get_level_expiry(int $level_id) : int
Parameters
$level_id : int
Tags
since
1.1
deprecated
2.1

use level_memberships()->get($level_id)->get_expiry()

see
RUA_User_Level_Interface::get_expiry()
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
since
1.1
Return values
array<string|int, int>

get_level_start()

public get_level_start(int $level_id) : int
Parameters
$level_id : int
Tags
since
1.1
deprecated
2.1

use level_memberships()->get($level_id)->get_start()

see
RUA_User_Interface::level_memberships()
Return values
int

has_global_access()

public has_global_access() : bool
Tags
since
1.1
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
since
1.1
Return values
bool

is_level_expired()

public is_level_expired(int $level_id) : bool
Parameters
$level_id : int
Tags
since
1.1
deprecated
2.1

use !level_memberships()->get($level_id)->is_active()

see
RUA_User_Level_Interface::is_active()
Return values
bool

remove_level()

public remove_level(int $level_id) : bool
Parameters
$level_id : int
Tags
since
1.1
Return values
bool

Search results