prefs.php
Table of Contents
- module_delete_userprefs() : mixed
- Delete all module user preferences.
- get_all_module_prefs() : array<string|int, mixed>
- Get all module prefs of a user.
- get_module_pref() : mixed
- Get pref of user for a given module and setting.
- set_module_pref() : mixed
- Set pref of user for a given module and setting.
- increment_module_pref() : mixed
- Increment pref of user for a given module and setting.
- clear_module_pref() : mixed
- Clear a setting for a given module and user.
- load_module_prefs() : array<string|int, mixed>
- Load prefs of a module.
Functions
module_delete_userprefs()
Delete all module user preferences.
module_delete_userprefs(int $user) : mixed
Parameters
- $user : int
Return values
mixed —get_all_module_prefs()
Get all module prefs of a user.
get_all_module_prefs([string $module = false ][, int $user = false ]) : array<string|int, mixed>
Parameters
- $module : string = false
- $user : int = false
Return values
array<string|int, mixed> —get_module_pref()
Get pref of user for a given module and setting.
get_module_pref(string $name[, string $module = false ][, int $user = false ]) : mixed
Parameters
- $name : string
- $module : string = false
- $user : int = false
Return values
mixed —set_module_pref()
Set pref of user for a given module and setting.
set_module_pref(string $name, mixed $value[, string $module = false ][, int $user = false ]) : mixed
Parameters
- $name : string
- $value : mixed
- $module : string = false
- $user : int = false
Return values
mixed —increment_module_pref()
Increment pref of user for a given module and setting.
increment_module_pref(string $name[, int|float $value = 1 ][, string $module = false ][, int $user = false ]) : mixed
Parameters
- $name : string
- $value : int|float = 1
- $module : string = false
- $user : int = false
Return values
mixed —clear_module_pref()
Clear a setting for a given module and user.
clear_module_pref(string $name[, string $module = false ][, int $user = false ]) : mixed
Parameters
- $name : string
- $module : string = false
- $user : int = false
Return values
mixed —load_module_prefs()
Load prefs of a module.
load_module_prefs(string $module[, int $user = false ]) : array<string|int, mixed>
Parameters
- $module : string
- $user : int = false