$modules->install() method

Install the given module name

Usage

// basic usage
$module = $modules->install(string $class);

// usage with all arguments
$module = $modules->install(string $class, $options = []);

Arguments

NameType(s)Description
classstring

Module name (class name)

options (optional)array, bool

Optional associative array that can contain any of the following:

  • dependencies (boolean): When true, dependencies will also be installed where possible. Specify false to prevent installation of uninstalled modules. (default=true)
  • resetCache (boolean): When true, module caches will be reset after installation. (default=true)
  • force (boolean): Force installation, even if dependencies can't be met.

Return value

null Module

Returns 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->install(…) 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->install(…) 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->install(…) 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

Latest news

  • ProcessWire Weekly #582
    The 582nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 5 July 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits