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

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer