Install the given module name
Usage
// basic usage
$module = $modules->install(string $class);
// usage with all arguments
$module = $modules->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
Hooking $modules->install(…)
You can add your own hook events that are executed either before or after the $modules method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.
Hooking before
The 'before' hooks are called immediately before each $modules method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('Modules::install', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$modules = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$class = $event->arguments(0);
$options = $event->arguments(1);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $class);
$event->arguments(1, $options);
});Hooking after
The 'after' hooks are called immediately after each $modules method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('Modules::install', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$modules = $event->object;
// An 'after' hook can retrieve and/or modify the return value
$return = $event->return;
// Get values of arguments sent to hook (if needed)
$class = $event->arguments(0);
$options = $event->arguments(1);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
});$modules methods and properties
API reference based on ProcessWire core version 3.0.248