API Documentation
Interfaces, Classes, Traits and Enums
Table of Contents
- rua_get_user() : RUA_User_Interface
- rua_get_level() : RUA_Level_Interface
- rua_get_user_level() : RUA_User_Level_Interface
- rua_get_user_levels() : RUA_Collection
- rua_get_level_members() : RUA_Collection
- rua_get_level_by_name() : WP_Post|bool
- rua_get_level_caps() : array<string|int, mixed>
Functions
rua_get_user()
rua_get_user([WP_User|int|null $user = null ]) : RUA_User_Interface
Parameters
- $user : WP_User|int|null = null
-
null or omit for current user
Tags
Return values
RUA_User_Interface —rua_get_level()
rua_get_level(WP_Post|int $post) : RUA_Level_Interface
Parameters
- $post : WP_Post|int
Tags
Return values
RUA_Level_Interface —rua_get_user_level()
rua_get_user_level(RUA_Level_Interface|WP_Post|int $level[, RUA_User_Interface|WP_User|int|null $user = null ]) : RUA_User_Level_Interface
Parameters
- $level : RUA_Level_Interface|WP_Post|int
- $user : RUA_User_Interface|WP_User|int|null = null
-
null or omit for current user
Tags
Return values
RUA_User_Level_Interface —rua_get_user_levels()
rua_get_user_levels(RUA_User_Interface|WP_User|int|null $user) : RUA_Collection
Parameters
- $user : RUA_User_Interface|WP_User|int|null
-
null or omit for current user
Return values
RUA_Collection —rua_get_level_members()
rua_get_level_members(RUA_Level_Interface|WP_Post|int $level[, array<string|int, mixed> $query = [] ]) : RUA_Collection
Parameters
- $level : RUA_Level_Interface|WP_Post|int
- $query : array<string|int, mixed> = []
Tags
Return values
RUA_Collection —rua_get_level_by_name()
rua_get_level_by_name(string $name) : WP_Post|bool
Parameters
- $name : string
Tags
Return values
WP_Post|bool —rua_get_level_caps()
rua_get_level_caps(int $level_id[, bool $hierarchical = false ]) : array<string|int, mixed>
Parameters
- $level_id : int
- $hierarchical : bool = false