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

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer