Install the given module name
Usage
// basic usage
$module = $modulesInstaller->install(string $class);
// usage with all arguments
$module = $modulesInstaller->install(string $class, $options = []);Arguments
| Name | Type(s) | Description |
|---|---|---|
class | string | Module name (class name) |
options (optional) | array, bool | Optional associative array that can contain any of the following:
|
Return value
null ModuleReturns null if unable to install, or ready-to-use Module object if successfully installed.
Exceptions
Method can throw exceptions on error:
WireException
ModulesInstaller methods and properties
API reference based on ProcessWire core version 3.0.248