BuddyClients Docs

users.php

Table of Contents

Functions

buddyc_is_team()  : str|bool
Check if user is a team member.
buddyc_is_client()  : str|bool
Check if user is a client.
buddyc_is_admin()  : bool
Check if user is a site admin.
buddyc_admin_id()  : mixed
Get site admin id.
buddyc_all_team()  : mixed
Get all team members.
buddyc_all_clients()  : mixed
Get all clients.
buddyc_member_types()  : array<string|int, mixed>
Retrieves member types.

Functions

buddyc_is_team()

Check if user is a team member.

buddyc_is_team([mixed $user_id = null ]) : str|bool
Parameters
$user_id : mixed = null

(optional. defaults to current user.)

Tags
since
0.1.0
Return values
str|bool

$member_type or false

buddyc_is_client()

Check if user is a client.

buddyc_is_client([mixed $user_id = null ]) : str|bool
Parameters
$user_id : mixed = null

(optional. defaults to current user.)

Tags
since
0.1.0
Return values
str|bool

$member_type or false

buddyc_is_admin()

Check if user is a site admin.

buddyc_is_admin([mixed $user_id = null ]) : bool
Parameters
$user_id : mixed = null

(optional. defaults to current user.)

Tags
since
0.1.0
Return values
bool

buddyc_admin_id()

Get site admin id.

buddyc_admin_id() : mixed
Tags
since
0.1.0

buddyc_all_team()

Get all team members.

buddyc_all_team() : mixed
Tags
since
0.1.0

buddyc_all_clients()

Get all clients.

buddyc_all_clients() : mixed
Tags
since
0.1.0

buddyc_member_types()

Retrieves member types.

buddyc_member_types([string $type = null ]) : array<string|int, mixed>
Parameters
$type : string = null

The type of member types to return. Accepts 'client', 'team', 'sales'.

Tags
since
0.1.0
Return values
array<string|int, mixed>

Associative array of member type names and labels.


        
On this page

Search results