ModulesLoader::initModule() method

Initialize a single module

Usage

// basic usage
$bool = $modulesLoader->initModule(Module $module);

// usage with all arguments
$bool = $modulesLoader->initModule(Module $module, array $options = []);

Arguments

NameType(s)Description
moduleModule
options (optional)array
  • clearSettings (bool): When true, module settings will be cleared when appropriate to save space. (default=true)
  • configOnly (bool): When true, module init() method NOT called, but config data still set (default=false) 3.0.169+
  • configData (array): Extra config data merge with module’s config data (default=[]) 3.0.169+
  • throw (bool): When true, exceptions will be allowed to pass through. (default=false)

Return value

bool

True on success, false on fail

Exceptions

Method can throw exceptions on error:

  • \Exception - Only if the throw option is true.


ModulesLoader 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

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.