class User

User Object This object stores almost everything you associate with the user it also provides core functions associated with the user such as login,logout

Traits

Static Cache Trait Adds a static (per request) cache to the object which can hold data for the time of the request (in the frontend) or a certain duration during long running processes. It works together with the global caching system and enforces a static cache clearing in case of global cache clearings as well.

Constants

ACTIVITY_UPDATE_INTERVAL_SEC

WEBSERVICE_OAUTH_METHOD

Set by the webservice as the login method for OAuth logins.

Properties

$GPvars
$policy
protected array $authentication_methods

Loaded from Config during init()

Methods

__destruct()

MAGIC Destructor is called when script execution ends

array
__sleep()

Called upon serialize

__wakeup()

Called upon deserialize

static bool
check_password($user_id, $plain_text_password, $hashed_password, string $salt = null)

Check password against a hashed version

clear($var)

No description

mixed
create_group(string $label, string $grouptype = 'group', int $pid = 0, string $name = "", int $is_active = 1, string $category = 'user_defined', string $description = "", string $css_class = "", string $groupconfig = "")

creates a group in sys|group.

mixed
executeInUserContext(Closure $closure, int $userID)

Execute function in user context

array|bool
find_policy(array $search_params, string $source = 'old_compat_mode')

No description

mixed
find_policy_values(string $instance, mixed $policy, string|bool $table = false, string $id_field = 'id', string $pid_field = 'pid', array|bool $group_context_ids = false, int|bool $group_security_id = false)

Find matches for a policy (Answers the question: To what IDs does the user have access)

get($var, $context = false)

Save a user setting (Duration: Session Lifetime) return mixed

array
getMetaPopData()

Fetches the meta data off the database from the selected user, if given. Otherwise the current user will be selected.

array|mixed
get_accessible_pages()

No description

string
get_filter_where_statement(string|bool $table_name = false, bool $strict = true)

Returns a SQL filter to filter by the usergroup of the current user (using fileds filter_allow and filter_deny)

string
get_group_class(int $user_id = false)

Get Group Classes for user

string
get_group_tree(bool|int $user_id = false, mixed $filter = false, bool $limit_to_tenant = false, bool $hide_systemonly = false)

Return the rights/roles/group tree todo This method should not be here, but in usermanagement_hook

array
get_groups(int $group_security_id = null)

No description

bool
get_message(string $status = FATAL)

Gets the last user message with the given status

get_mobile_token()

No description

get_page_options($instance_id, $page_id)

No description

mixed
get_policy_cluster_centroids(mixed $cluster_id)

Loads the Centroid of a given Policy Cluster into cache and returns it

bool
get_policy_security_level(string $instance, string $policy)

Returns the required minimum security level for the passed policy

mixed
get_policy_user_diff($user_id)

Loads the Policy User Diff of a given user into cache and returns it

array|bool
get_security_context(string $instance)

Get Security Context

string
get_session_auth_method()

Get the current Auth Method for this session

get_setting($var, $instance_id = false)

Get a user setting (Duration: User Lifetime) return bool success

User|bool
get_user_by_login(string $login, string $password = NULL)

Return User ID by given login/password

string
get_user_cache_id(int $user_id = 0)

Return a fixed length string (e.g. 00000001 for userid 1)

int|string
get_user_id(bool $format_for_cache = false)

!Accessor

int
get_user_id_by_email(string $email)

returns user_id found through given email address Warning: expects user emails to be unique! only one id is returned

int
get_user_id_by_login(string $login, string $password = NULL)

Return User ID by given login/password

array
get_user_ids_by_meta_value(string $meta_field_name, mixed $meta_values, bool $active_only = true)

returns an array of all user_ids matching the given meta-field conditions

get_user_obj(int|string|array|bool $user_id = false, bool $useCache = true)

No description

get_user_obj_by_email(string $email)

returns user_object found through given email address Warning: expects user emails to be unique! only one object is returned

int
get_userid_by_email(string $email)

No description

bool
has_access(string $instance_id, string|bool $page = false, int $group_security_id = 0, bool $include_public_pages = true)

No description

bool
has_policy(string $instance, string $policy, string $value = '*', string|bool $target_user = false, int|bool $group_security_id = false, string $default_policy = 'deny')

No description

bool
has_policy_by_security_level(string $instance, string $policy, string $security_level)

No description

array|bool
has_tree_policy(string $instance, string $policy, string $value, string $table = false, string $id_field = 'id', string $pid_field = 'pid', int $group_security_id = false, bool $default_access = false, string $is_root_field = false, int $context_id = false)

No description

static string
hash_password(string $user_id, string $plain_text_password, string $salt = null, bool $use_old_algorithm = false)

Hash the password for the user database with bcrypt

bool
in_group(mixed $group_id)

Check if User is in a specific group

init()

No description

bool
isApiAccess()

Checks if the user is logged in via OAuth in the view with a bearer token.

bool
isUserStatusEnabled()

Determines if the "Enable online status" setting in system_userprofile is activated or not

bool
is_admin_auth_required()

Is additional authentication required for this user?

bool
is_controlled_via_auth()

Can user change login, password, email? Or is this controlled via auth?

is_guest()

No description

bool
is_loaded()

Returns true when the user object has loaded the settings and the user object is usable

is_logged_in()

No description

bool
is_two_factor_auth_activated($global_enforcement_only = false)

Check if 2-Factor-Auth is activated and applicable for the currently logged in user

bool
is_two_factor_needed()

Check if the user needs to use two factor authorization.

true
is_urlaccess()

No description

load_settings()

Load user settings from database (user needs to be logged in)

load_user_groups()

Load User Security Groups from Session or DB, depending on availability or dirty session

load_user_policy(string $instance, string $policy, string $value = false, int[] $group_security_ids = array(), string $default_policy = 'deny')

lazy load policy for user

bool
login(string $login, string $password, bool $this_login_only = false, array $disallowed_methods = null)

Try to login the user/pass

bool
logout(bool $skip_auth_logout = false)

Logout out the current user

new_user_obj(string $login = null)

New User Object optional: Supply login to check for

bool
refresh(bool $only_user_specific = false)

No description

reload()

this function will reload all user-relevant data e.g. very important, if this user has joined a certain rights-group and needs to obtain this group's rights without re-login

string
resolve_group_id(mixed $group_short_id)

Returns the numeric id for the passed group short id (verbose group id)

static string
salt_password($user_id, $plain_text_password, string $salt = null)

Salt a password

send_two_factor_code()

Sends an email to the user with the authentication token required for two factor authentication.

set($var, $value)

Save a user setting (Duration: Session Lifetime) return void

set_group_policy(array $groups, string $instance, string $policy, mixed $value = false, bool $allow_parity = true, int $group_security_id = 0)

No description

set_message(string $msg, string $status = OK)

Sets a user message

set_policy(string $instance, string $policy, string $value = '', bool $allow = true)

No description

void
set_security_context(string $instance, $security_level, $exclude_dyn_policies = false)

Set Security Context

string
set_session_auth_method($auth_method)

Get the current Auth Method for this session

set_setting($var, $value, $instance_id = false)

Save a user setting (Duration: User Lifetime) return void

set_user_policy(int|int[] $users, string $instance, string $policy, mixed $value = '', bool $allow_parity = true, bool $modify_only_passed_users = false, int $group_security_id = 0)

No description

set_xf_user_mode(string $action, int|bool $new_user_id = false, $is_guest = false)

this function sets the XF mode to USER and sets the used user to given id

static void
static void
staticCacheClearCachePool($cache_pool = 'default')

Clears the specified cache pool from the static cache

static array|string|int|bool|null
staticCacheGet($key, string $cache_pool = 'default')

Retrieves a value from the static cache

static array
staticCacheGetKeys(string $cache_pool = 'default')

Returns an array of all cache keys which have been set

static array
staticCacheGetPool($cache_pool)

Returns an key/value array with all cached values from the passed pool

static bool
staticCacheIsEnabled()

No description

static bool
staticCacheIsSet($key, string $cache_pool = 'default')

Checks if the passed is key has a value set

static 
staticCacheRemove($key, string $cache_pool = 'default')

Removes the passed key

static void
staticCacheSet(string|int $key, mixed $value, string $cache_pool = 'default')

Store a value in the static cache

switchUser(int $userId, string $loginMethod)

Switches the currently logged in user to the selected user.

bool|mixed
update_displayname(mixed $user_id = false, string $force_display_name = '')

Update Displayname

user_exists($login)

Checks wether a specific user already exists in the user db

user_init($only_user_specific = false)

No description

Details

at line 73
__destruct()

MAGIC Destructor is called when script execution ends

at line 103
array __sleep()

Called upon serialize

This object should NEVER be serialized!

Return Value

array

at line 118
__wakeup()

Called upon deserialize

at line 314
static bool check_password($user_id, $plain_text_password, $hashed_password, string $salt = null)

Check password against a hashed version

Parameters

$user_id
$plain_text_password
$hashed_password
string $salt

If no salt is given the system standard salt is used

Return Value

bool

at line 1507
clear($var)

No description

Parameters

$var

at line 3302
mixed create_group(string $label, string $grouptype = 'group', int $pid = 0, string $name = "", int $is_active = 1, string $category = 'user_defined', string $description = "", string $css_class = "", string $groupconfig = "")

creates a group in sys|group.

Parameters

string $label
string $grouptype
int $pid
string $name
int $is_active
string $category
string $description
string $css_class
string $groupconfig

Return Value

mixed

$result_id, id of group or false on failure

Exceptions

Exception

at line 3472
mixed executeInUserContext(Closure $closure, int $userID)

Execute function in user context

Parameters

Closure $closure
int $userID

Return Value

mixed

at line 2560
array|bool find_policy(array $search_params, string $source = 'old_compat_mode')

No description

Parameters

array $search_params

Array with all search parameters, use the field as key in the array. Percent % and question mark wildcards are allowed (SQL)

string $source

both, group, user

Return Value

array|bool

Multi-Dim Array with all matching policies, FALSE if no match -- todo: New union types array|false PHP 8.0

at line 2431
mixed find_policy_values(string $instance, mixed $policy, string|bool $table = false, string $id_field = 'id', string $pid_field = 'pid', array|bool $group_context_ids = false, int|bool $group_security_id = false)

Find matches for a policy (Answers the question: To what IDs does the user have access)

Parameters

string $instance

INSTANCE ID (mod->context) or instance object

mixed $policy
string|bool $table

table where the id->pid structure is stored [IF you need tree evaluation]

string $id_field

name of the id field in table

string $pid_field

name of the pid field in table

array|bool $group_context_ids

group_context ids (policy entries on destination table are filtered by this ids in group_id column)

int|bool $group_security_id

Global Group Security ID

Return Value

mixed

TRUE: User does have access to all possible values, FALSE: User does have no access at all, ARRAY: User is allowed to the specified values - Array is flat: [0, 1, 2, 3]

at line 1497
get($var, $context = false)

Save a user setting (Duration: Session Lifetime) return mixed

Parameters

$var
$context

at line 3498
array getMetaPopData()

Fetches the meta data off the database from the selected user, if given. Otherwise the current user will be selected.

Return Value

array

Exceptions

DatabaseException

at line 943
array|mixed get_accessible_pages()

No description

Return Value

array|mixed

Exceptions

Exception

at line 1051
string get_filter_where_statement(string|bool $table_name = false, bool $strict = true)

Returns a SQL filter to filter by the usergroup of the current user (using fileds filter_allow and filter_deny)

Parameters

string|bool $table_name

Table Name

bool $strict

Use Strict mode --> If strict mode is disabled than an empty allow field will be intepreted as allow for ALL

Return Value

string

at line 1774
string get_group_class(int $user_id = false)

Get Group Classes for user

Parameters

int $user_id

Return Value

string

CSS Classes separated by spaces

at line 3028
string get_group_tree(bool|int $user_id = false, mixed $filter = false, bool $limit_to_tenant = false, bool $hide_systemonly = false)

Return the rights/roles/group tree todo This method should not be here, but in usermanagement_hook

Parameters

bool|int $user_id
mixed $filter

can be 'group','role','organisation' as array

bool $limit_to_tenant
bool $hide_systemonly

Return Value

string

at line 1636
array get_groups(int $group_security_id = null)

No description

Parameters

int $group_security_id

Return Value

array

at line 1597
bool get_message(string $status = FATAL)

Gets the last user message with the given status

Example:

$XF->lib->user->set_message(_("File has been saved successfull"),OK);
echo ($XF->lib->user->get_message(OK));

Parameters

string $status

Status of the last message

Return Value

bool

at line 854
get_mobile_token()

No description

at line 913
get_page_options($instance_id, $page_id)

No description

Parameters

$instance_id
$page_id

at line 1800
mixed get_policy_cluster_centroids(mixed $cluster_id)

Loads the Centroid of a given Policy Cluster into cache and returns it

Parameters

mixed $cluster_id

The ID of the centroid's policy cluster to load

Return Value

mixed

The actual centroid as an assoc array

at line 2192
bool get_policy_security_level(string $instance, string $policy)

Returns the required minimum security level for the passed policy

Parameters

string $instance

Instance ID

string $policy

Policy Name

Return Value

bool

at line 1846
mixed get_policy_user_diff($user_id)

Loads the Policy User Diff of a given user into cache and returns it

Parameters

$user_id

Return Value

mixed

The actual user diff as an assoc array

at line 2374
array|bool get_security_context(string $instance)

Get Security Context

Parameters

string $instance

Return Value

array|bool

array('level'=>,'exclude_dyn_policies'=>)

at line 1430
string get_session_auth_method()

Get the current Auth Method for this session

Return Value

string

AuthMethod

at line 1558
get_setting($var, $instance_id = false)

Get a user setting (Duration: User Lifetime) return bool success

Parameters

$var
$instance_id

at line 1333
User|bool get_user_by_login(string $login, string $password = NULL)

Return User ID by given login/password

Parameters

string $login
string $password

Return Value

User|bool

at line 1405
string get_user_cache_id(int $user_id = 0)

Return a fixed length string (e.g. 00000001 for userid 1)

Parameters

int $user_id

Return Value

string

at line 1382
int|string get_user_id(bool $format_for_cache = false)

!Accessor

Parameters

bool $format_for_cache

will return a fixed length string (e.g. 00000001 for userid 1)

Return Value

int|string

at line 1261
int get_user_id_by_email(string $email)

returns user_id found through given email address Warning: expects user emails to be unique! only one id is returned

Parameters

string $email

Return Value

int

$id

at line 1317
int get_user_id_by_login(string $login, string $password = NULL)

Return User ID by given login/password

Parameters

string $login
string $password

Return Value

int

User ID or false for n.a.

at line 3365
array get_user_ids_by_meta_value(string $meta_field_name, mixed $meta_values, bool $active_only = true)

returns an array of all user_ids matching the given meta-field conditions

Parameters

string $meta_field_name

name of the meta field

mixed $meta_values

single value or an array of values

bool $active_only

Return only users with status = active

Return Value

array

with user_ids

at line 1221
User|User[] get_user_obj(int|string|array|bool $user_id = false, bool $useCache = true)

No description

Parameters

int|string|array|bool $user_id

User ID (false=current user, INT or ARRAY, -1 for new object)

bool $useCache

Return Value

User|User[]

at line 1297
User get_user_obj_by_email(string $email)

returns user_object found through given email address Warning: expects user emails to be unique! only one object is returned

Parameters

string $email

Return Value

User

at line 2998
int get_userid_by_email(string $email)

No description

Parameters

string $email

eMail Address

Return Value

int

User ID

at line 875
bool has_access(string $instance_id, string|bool $page = false, int $group_security_id = 0, bool $include_public_pages = true)

No description

Parameters

string $instance_id

instance_id

string|bool $page

page_id

int $group_security_id
bool $include_public_pages

Return Value

bool

user has access

at line 2112
bool has_policy(string $instance, string $policy, string $value = '*', string|bool $target_user = false, int|bool $group_security_id = false, string $default_policy = 'deny')

No description

Parameters

string $instance

Instance ID (normally $this->context in modules)

string $policy

Context

string $value

Policy

string|bool $target_user
int|bool $group_security_id
string $default_policy

Return Value

bool

at line 2168
bool has_policy_by_security_level(string $instance, string $policy, string $security_level)

No description

Parameters

string $instance

Instance ID (normally $this->context in modules)

string $policy

Policy ID

string $security_level

Security Level as defined in Policy Definition

Return Value

bool

at line 2228
array|bool has_tree_policy(string $instance, string $policy, string $value, string $table = false, string $id_field = 'id', string $pid_field = 'pid', int $group_security_id = false, bool $default_access = false, string $is_root_field = false, int $context_id = false)

No description

Parameters

string $instance

instance id (normally $this->context in modules)

string $policy

policy

string $value

value Policy Value

string $table

table where the id->pid structure is stored

string $id_field

name of the id field in table

string $pid_field

name of the pid field in table

int $group_security_id

id of the group security

bool $default_access

default value if no other is filled

string $is_root_field

name of the root field. if this is set and filled with "1", the level of the tree will be interpreted as an alternative root. BEWARE: default access is treated as FALSE in this case!!

int $context_id

A policy value id cutting the tree of. Will be treated as the root entry for this check. Policies are considered down to, but NOT INCLUDING this root entry. BEWARE: default access is NOT treated as FALSE in this case, but left as defined!!

Return Value

array|bool

with all groups having the requested policy

at line 283
static string hash_password(string $user_id, string $plain_text_password, string $salt = null, bool $use_old_algorithm = false)

Hash the password for the user database with bcrypt

Parameters

string $user_id

login name (used for salting)

string $plain_text_password

plain text password

string $salt

If no salt is given the system standard salt is used

bool $use_old_algorithm

sha1

Return Value

string

Hashed and Salted Password

at line 1619
bool in_group(mixed $group_id)

Check if User is in a specific group

Parameters

mixed $group_id

GRP_identifier

Return Value

bool

success

at line 138
init()

No description

at line 1488
bool isApiAccess()

Checks if the user is logged in via OAuth in the view with a bearer token.

Return Value

bool

at line 3530
bool isUserStatusEnabled()

Determines if the "Enable online status" setting in system_userprofile is activated or not

Return Value

bool

at line 1466
bool is_admin_auth_required()

Is additional authentication required for this user?

Return Value

bool

at line 1438
bool is_controlled_via_auth()

Can user change login, password, email? Or is this controlled via auth?

Return Value

bool

at line 861
is_guest()

No description

at line 1527
bool is_loaded()

Returns true when the user object has loaded the settings and the user object is usable

Return Value

bool

at line 1410
is_logged_in()

No description

at line 352
bool is_two_factor_auth_activated($global_enforcement_only = false)

Check if 2-Factor-Auth is activated and applicable for the currently logged in user

Parameters

$global_enforcement_only

Return Value

bool

at line 393
bool is_two_factor_needed()

Check if the user needs to use two factor authorization.

Return Value

bool

at line 849
true is_urlaccess()

No description

Return Value

true

if this user logged in via mobile_token

at line 1534
load_settings()

Load user settings from database (user needs to be logged in)

at line 1706
protected load_user_groups()

Load User Security Groups from Session or DB, depending on availability or dirty session

at line 2004
load_user_policy(string $instance, string $policy, string $value = false, int[] $group_security_ids = array(), string $default_policy = 'deny')

lazy load policy for user

Parameters

string $instance
string $policy
string $value

(0-9 = ID; ? = min one valid value in a dynamic policy; * = static policy)

int[] $group_security_ids

or array $group_security_id(s)

string $default_policy

default policy if no explicit policy is set

at line 441
bool login(string $login, string $password, bool $this_login_only = false, array $disallowed_methods = null)

Try to login the user/pass

Parameters

string $login

Login/Username

string $password

Pass

bool $this_login_only

strict check for login-parameter (avoids guest-auth)

array $disallowed_methods

Return Value

bool

success

Exceptions

AuthenticationException

at line 1117
bool logout(bool $skip_auth_logout = false)

Logout out the current user

Parameters

bool $skip_auth_logout

Return Value

bool

success

at line 1168
User new_user_obj(string $login = null)

New User Object optional: Supply login to check for

Parameters

string $login

Return Value

User

Exceptions

UserCreationException

at line 1088
bool refresh(bool $only_user_specific = false)

No description

Parameters

bool $only_user_specific

Return Value

bool

at line 3259
reload()

this function will reload all user-relevant data e.g. very important, if this user has joined a certain rights-group and needs to obtain this group's rights without re-login

at line 1654
string resolve_group_id(mixed $group_short_id)

Returns the numeric id for the passed group short id (verbose group id)

Parameters

mixed $group_short_id

Numeric or Alphanumeric Group ID

Return Value

string

at line 299
static string salt_password($user_id, $plain_text_password, string $salt = null)

Salt a password

Parameters

$user_id
$plain_text_password
string $salt

If no salt is given the system standard salt is used

Return Value

string

at line 419
send_two_factor_code()

Sends an email to the user with the authentication token required for two factor authentication.

at line 1516
set($var, $value)

Save a user setting (Duration: Session Lifetime) return void

Parameters

$var
$value

at line 2725
set_group_policy(array $groups, string $instance, string $policy, mixed $value = false, bool $allow_parity = true, int $group_security_id = 0)

No description

Parameters

array $groups

Group ID(s)

string $instance

Instance ID (normally $this->context in modules)

string $policy

Policy

mixed $value

Value

bool $allow_parity

Allow?

int $group_security_id

at line 1577
set_message(string $msg, string $status = OK)

Sets a user message

Used for intra-module message exchange, e.g. save or error messages

Parameters

string $msg

Message in current language

string $status

Status of message [OK, CANCEL, FATAL, PROCEED]

at line 2857
set_policy(string $instance, string $policy, string $value = '', bool $allow = true)

No description

Parameters

string $instance

Instance ID (normally $this->context in modules)

string $policy

Policy

string $value

Value

bool $allow

Allow Policy

at line 2360
void set_security_context(string $instance, $security_level, $exclude_dyn_policies = false)

Set Security Context

Parameters

string $instance
$security_level
$exclude_dyn_policies

Return Value

void

at line 1422
string set_session_auth_method($auth_method)

Get the current Auth Method for this session

Parameters

$auth_method

Return Value

string

AuthMethod

at line 1549
set_setting($var, $value, $instance_id = false)

Save a user setting (Duration: User Lifetime) return void

Parameters

$var
$value
$instance_id

at line 2875
set_user_policy(int|int[] $users, string $instance, string $policy, mixed $value = '', bool $allow_parity = true, bool $modify_only_passed_users = false, int $group_security_id = 0)

No description

Parameters

int|int[] $users

User ID(s)

string $instance

Instance ID (normally $this->context in modules)

string $policy

Policy Name

mixed $value

Value

bool $allow_parity

Allow?

bool $modify_only_passed_users

Set to true if only the passed users shall be changed - otherwise this policy gets removed for users other than in the passed userid list!

int $group_security_id

Exceptions

AuditException

at line 3194
set_xf_user_mode(string $action, int|bool $new_user_id = false, $is_guest = false)

this function sets the XF mode to USER and sets the used user to given id

it is used for daemons to be able to use user context

Parameters

string $action

action [enable|disable]

int|bool $new_user_id

user_id to set

$is_guest

in StaticCacheTrait at line 121
static void staticCacheClearAllCachePools()

No description

Return Value

void

in StaticCacheTrait at line 114
static void staticCacheClearCachePool($cache_pool = 'default')

Clears the specified cache pool from the static cache

Parameters

$cache_pool

Return Value

void

in StaticCacheTrait at line 61
static array|string|int|bool|null staticCacheGet($key, string $cache_pool = 'default')

Retrieves a value from the static cache

Parameters

$key
string $cache_pool

Return Value

array|string|int|bool|null

Returns the cached result or null if no value has been stored

in StaticCacheTrait at line 98
static array staticCacheGetKeys(string $cache_pool = 'default')

Returns an array of all cache keys which have been set

Parameters

string $cache_pool

Return Value

array

in StaticCacheTrait at line 107
static array staticCacheGetPool($cache_pool)

Returns an key/value array with all cached values from the passed pool

Parameters

$cache_pool

Return Value

array

in StaticCacheTrait at line 34
static bool staticCacheIsEnabled()

No description

Return Value

bool

in StaticCacheTrait at line 85
static bool staticCacheIsSet($key, string $cache_pool = 'default')

Checks if the passed is key has a value set

Parameters

$key
string $cache_pool

Return Value

bool

in StaticCacheTrait at line 73
static staticCacheRemove($key, string $cache_pool = 'default')

Removes the passed key

Parameters

$key
string $cache_pool

in StaticCacheTrait at line 46
static void staticCacheSet(string|int $key, mixed $value, string $cache_pool = 'default')

Store a value in the static cache

Parameters

string|int $key
mixed $value
string $cache_pool

ID for the cache pool which should be used

Return Value

void

at line 3540
switchUser(int $userId, string $loginMethod)

Switches the currently logged in user to the selected user.

Parameters

int $userId
string $loginMethod

at line 3414
bool|mixed update_displayname(mixed $user_id = false, string $force_display_name = '')

Update Displayname

Parameters

mixed $user_id
string $force_display_name

Return Value

bool|mixed

at line 1681
user_exists($login)

Checks wether a specific user already exists in the user db

Parameters

$login

at line 175
user_init($only_user_specific = false)

No description

Parameters

$only_user_specific