modules.php
Table of Contents
- module_check_requirements() : bool
- Checks if the module requirements are satisfied. Should a module require other modules to be installed and active, then optionally makes them so.
- mass_module_prepare() : bool
- Preloads data for multiple modules in one shot rather than having to make SQL calls for each hook, when many of the hooks are found on every page.
- get_module_info() : mixed
- module_editor_navs() : mixed
- module_objpref_edit() : mixed
- module_compare_versions() : mixed
- module_condition() : bool
- Evaluates a PHP Expression.
- get_racename() : mixed
- module_pref_filter() : mixed
Functions
module_check_requirements()
Checks if the module requirements are satisfied. Should a module require other modules to be installed and active, then optionally makes them so.
module_check_requirements(array<string|int, mixed> $reqs[, mixed $forceinject = false ]) : bool
Parameters
- $reqs : array<string|int, mixed>
-
Requirements of a module from _getmoduleinfo()
- $forceinject : mixed = false
Return values
bool —If successful or not
mass_module_prepare()
Preloads data for multiple modules in one shot rather than having to make SQL calls for each hook, when many of the hooks are found on every page.
mass_module_prepare(array<string|int, mixed> $hooknames) : bool
Parameters
- $hooknames : array<string|int, mixed>
-
names of hooks whose attached modules should be preloaded
Return values
bool —Success
get_module_info()
get_module_info(mixed $shortname) : mixed
Parameters
- $shortname : mixed
Return values
mixed —module_editor_navs()
module_editor_navs(mixed $like, mixed $linkprefix) : mixed
Parameters
- $like : mixed
- $linkprefix : mixed
Return values
mixed —module_objpref_edit()
module_objpref_edit(mixed $type, mixed $module, mixed $id) : mixed
Parameters
- $type : mixed
- $module : mixed
- $id : mixed
Return values
mixed —module_compare_versions()
module_compare_versions(mixed $a, mixed $b) : mixed
Parameters
- $a : mixed
- $b : mixed
Return values
mixed —module_condition()
Evaluates a PHP Expression.
module_condition(string $condition) : bool
Parameters
- $condition : string
-
The PHP condition to evaluate
Return values
bool —The result of the evaluated expression
get_racename()
get_racename([mixed $thisuser = true ]) : mixed
Parameters
- $thisuser : mixed = true
Return values
mixed —module_pref_filter()
module_pref_filter(mixed $a) : mixed
Parameters
- $a : mixed