Get a module, get module information, and much more ($modules API variable as a function)
This function behaves the same as the $modules
API variable, though does support
an optional shortcut argument for getting a module.
Example
$modules = modules(); // Simply get $modules API var
$module = modules()->get('ModuleName'); // Get a module
$module = modules('ModuleName'); // Shortcut to get a module
Usage
// basic usage
$modules = modules();
// usage with all arguments
$modules = modules(string $name = '');
Arguments
Name | Type(s) | Description |
---|---|---|
name (optional) | string | Optionally retrieve the given module name |
Return value
Modules
Module
ConfigurableModule
null
Functions methods and properties
API reference based on ProcessWire core version 3.0.236