ModulesLoader::initModule()

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