Get the requested Module
- If the module is not installed, but is installable, it will be installed, instantiated, and initialized.
If you don't want that behavior, call
$modules->isInstalled('ModuleName')
as a conditional first. - You can also get/load a module by accessing it directly, like
$modules->ModuleName
. - To get a module with additional options, use
$modules->getModule($name, $options)
instead.
Example
// Get the MarkupAdminDataTable module
$table = $modules->get('MarkupAdminDataTable');
// You can also do this
$table = $modules->MarkupAdminDataTable;
Usage
$module = $modules->get($key);
Arguments
Name | Type(s) | Description |
---|---|---|
key | string, int | Module name (also accepts database ID) |
Return value
Exceptions
Method can throw exceptions on error:
WirePermissionException
- If module requires a particular permission the user does not have
See Also
$modules methods and properties
API reference based on ProcessWire core version 3.0.236