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

“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