Modules / $modules

// Get a module by name — returns null if not found
$m = $modules->get('MarkupPagerNav');
$m = $modules->MarkupPagerNav; // alternate property-access form

// Get with options
$m = $modules->getModule('ModuleName', [
    'noInit'             => true,  // don't call module init()
    'noInstall'          => true,  // don't auto-install if uninstalled
    'noPermissionCheck'  => true,  // skip permission check
    'noThrow'            => true,  // return null instead of throwing
    'configData'         => [...], // extra config data to merge in
]);

getModule() options

Return value is an array indexed by module class name and the contents of the returned array is dictated by the $load argument. All three find methods accept the same $load argument:

// Find modules whose class name starts with a prefix
$inputfields = $modules->findByPrefix('Inputfield');
$inputfields = $modules->findByPrefix('Inputfield', true);  // load=true: get instances

// Find modules that have a given flag set (fastest method)
$cliModules  = $modules->findByFlag(Modules::flagsCli);
$autoloaders = $modules->findByFlag(Modules::flagsAutoload, 1); // load=1: get info arrays

// Find modules by a module info property or selector
$autoloads = $modules->findByInfo('autoload');             // non-empty 'autoload'
$matches   = $modules->findByInfo('autoload=1, core=1');   // selector string
$matches   = $modules->findByInfo('author*=Ryan, core=0'); // partial match 'Ryan'
$matches   = $modules->findByInfo(['autoload' => 1]);      // array match

getModuleInfo() returns an associative array with at least these properties:

getModuleInfoVerbose() additionally returns the following:

• permissions value example: ['permission-name' => 'Description description']

getModuleInfo usage examples

// Get common module info
$info = $modules->getModuleInfo('ModuleName');
echo $info['title'];
echo $modules->formatVersion($info['version']); // e.g. "1.2.3"

// Get verbose module info (includes summary, author, file, core, etc.)
$info = $modules->getModuleInfoVerbose('ModuleName');

// Get a single module info property (uses cache, fast)
$version = $modules->getModuleInfoProperty('ModuleName', 'version');

// Get abbreviated info for all installed modules, indexed by module ID
$all = $modules->getModuleInfo('*');

// Get a blank info template array (all keys with default values)
$template = $modules->getModuleInfo('info');

getModuleInfo for Process modules

Modules of type Process also may optionally include the following in their verbose module info. Please see the Process module interface wire/core/Module/Process/Process.php for details.

page value example:

'page' => [ 'name' => 'foo', 'parent' => 'setup', 'title' => 'Foo' ],

nav value example:

'nav' => [ 
    [ 'url' => '', 'label' => 'Foo', 'icon' => 'smile-o' ],
    [ 'url' => 'bar/', 'label' => 'Bar', 'icon' => 'home' ],
    [ 'url' => 'baz/', 'label' => 'Baz', 'icon' => 'sliders' ]
],

Hook before or after any of the following methods:

// Example: log after a module is installed
$wire->addHookAfter('Modules::install', function(HookEvent $e) {
    $class  = $e->arguments(0); // module class name (string)
    $module = $e->return;       // installed Module object
    $this->log("Installed module: $class");
});

// Example: hook directly to $modules, before config is saved
// and display an notification of what is being saved
$modules->addHookBefore('saveConfig', function(HookEvent $e) {
    $module = $e->arguments(0); // Module class or instance
    $class = $module instanceof Module ? $module->className() : $module;
    $data = $e->arguments(1); // array of data, or property name string
    if(is_array($data)) {
        // saving entire module config
        $e->message([ "Saving $class config data" => $data ]);
    } else {
        // saving just a property of the config
        $property = $data;
        $value = $e->arguments(2);
        $e->message([ "Saving module $class $property" => $value ]);
    }
});