ModulesInstaller::install() method

Install the given module name

Usage

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

// usage with all arguments
$module = $modulesInstaller->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


ModulesInstaller methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #560
    In the 560th issue of ProcessWire Weekly we'll check out the latest core updates, cover newly released ProcessWire modules, and more. Read on!
    Weekly.pw / 1 February 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 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