settings.php
Table of Contents
- get_all_module_settings() : array<string|int, mixed>
- An associative array of all the settings for the given module.
- get_module_setting() : mixed
- Get value for setting of a module.
- set_module_setting() : mixed
- Set value for setting of a module.
- increment_module_setting() : mixed
- Increment value for a setting of module.
- clear_module_settings() : mixed
- Clear settings of a module.
- load_module_settings() : array<string|int, mixed>
- Load settings of a module.
Functions
get_all_module_settings()
An associative array of all the settings for the given module.
get_all_module_settings([string $module = false ]) : array<string|int, mixed>
Parameters
- $module : string = false
Return values
array<string|int, mixed> —get_module_setting()
Get value for setting of a module.
get_module_setting(mixed $name[, mixed $module = false ]) : mixed
Parameters
- $name : mixed
- $module : mixed = false
Return values
mixed —set_module_setting()
Set value for setting of a module.
set_module_setting(string $name, mixed $value[, string $module = false ]) : mixed
Parameters
- $name : string
- $value : mixed
- $module : string = false
Return values
mixed —increment_module_setting()
Increment value for a setting of module.
increment_module_setting(string $name[, float|int $value = 1 ][, string $module = false ]) : mixed
Parameters
- $name : string
- $value : float|int = 1
- $module : string = false
Return values
mixed —clear_module_settings()
Clear settings of a module.
clear_module_settings([string $module = false ]) : mixed
Parameters
- $module : string = false
Return values
mixed —load_module_settings()
Load settings of a module.
load_module_settings(string $module) : array<string|int, mixed>
Parameters
- $module : string