ModulesInstaller::install()

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.252