$modules API variable / Modules class

Loads and manages all modules in ProcessWire.

The $modules API variable is most commonly used for getting individual modules to use their API.

// Getting a module by name
$m = $modules->get('MarkupPagerNav');

// Getting a module by name (alternate)
$m = $modules->MarkupPagerNav;

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Modules class also inherits all the methods and properties of: WireArray and Wire.

Common

Name	Return	Summary
$modules->configs	`ModulesConfigs`
$modules->coreModulesDir	`string`
$modules->coreModulesPath	`string`
$modules->files	`ModulesFiles`
$modules->findByInfo() $modules->findByInfo($selector) $modules->findByInfo($selector, $load = false)	`array`	Find modules by matching a property or properties in their module info
$modules->findByPrefix() $modules->findByPrefix(string $prefix) $modules->findByPrefix(string $prefix, $load = false)	`array`	Find modules matching the given prefix (i.e. “Inputfield”)
$modules->flags	`ModulesFlags`
$modules->get() $modules->get($key) $modules->get($key)	`Module` `_Module` `null`	Get the requested Module
$modules->getDebugData() $modules->getDebugData() $modules->getDebugData()	(nothing)
$modules->getModule() $modules->getModule($key) $modules->getModule($key, array $options = [])	`Module` `_Module` `null` `string`	Get the requested Module (with options)
$modules->getModuleFile() $modules->getModuleFile($class) $modules->getModuleFile($class, $options = [])	`bool` `string`	Get the path + filename (or optionally URL) for this module
$modules->getModuleID() $modules->getModuleID($class) $modules->getModuleID($class)	`int`	Returns the database ID of a given module class, or 0 if not found
$modules->getModuleInfo() $modules->getModuleInfo($class) $modules->getModuleInfo($class, array $options = [])	`array`	Returns an associative array of information for a Module
$modules->getModuleInfoProperty() $modules->getModuleInfoProperty($class, string $property) $modules->getModuleInfoProperty($class, string $property, array $options = [])	`mixed` `null`	Get just a single property of module info
$modules->getModuleInfoVerbose() $modules->getModuleInfoVerbose($class) $modules->getModuleInfoVerbose($class, array $options = [])	`array`	Returns a verbose array of information for a Module
$modules->getModuleLanguageFiles() $modules->getModuleLanguageFiles($module) $modules->getModuleLanguageFiles($module)	`array`	Get module language translation files
$modules->info	`ModulesInfo`
$modules->installableFiles	`array`
$modules->installer	`ModulesInstaller`
$modules->isInstalled() $modules->isInstalled(string $class) $modules->isInstalled(string $class)	`bool`	Is the given module name installed?
$modules->loader	`ModulesLoader`
$modules->memcache() $modules->memcache(string $name) $modules->memcache(string $name, mixed $setValue = null)	`bool` `array` `mixed` `null`	Set a runtime memory cache
$modules->moduleIDs	`array`
$modules->moduleNames	`array`
$modules->refreshing	`bool`
$modules->siteModulesPath	`string`

Manipulation

Name	Return	Summary
$modules->delete() $modules->delete(string $class) $modules->delete(string $class)	`bool`	Delete the given module, physically removing its files
$modules->install() $modules->install(string $class) $modules->install(string $class, $options = [])	`null` `Module`	Install the given module name
$modules->refresh() $modules->refresh() $modules->refresh(bool $showMessages = false)	(nothing)	Refresh the modules cache
$modules->saveConfig() $modules->saveConfig($class, $data) $modules->saveConfig($class, $data, $value = null)	`bool`	Save provided configuration data for the given module
$modules->uninstall() $modules->uninstall(string $class) $modules->uninstall(string $class)	`bool`	Uninstall the given module name

Configuration

Name	Return	Summary
$modules->getConfig() $modules->getConfig($class) $modules->getConfig($class, string $property = '')	`array` `string` `int` `float`	Given a module name, return an associative array of configuration data for it
$modules->getModuleEditUrl() $modules->getModuleEditUrl($className) $modules->getModuleEditUrl($className, bool $collapseInfo = true)	`string`	Return the URL where the module can be edited, configured or uninstalled
$modules->getModuleInstallUrl() $modules->getModuleInstallUrl(string $className) $modules->getModuleInstallUrl(string $className)	`string`	Get URL where an administrator can install given module name
$modules->isConfigurable() $modules->isConfigurable($class) $modules->isConfigurable($class, bool $useCache = true)	`bool` `string` `int`	Is the given module interactively configurable?
$modules->saveConfig() $modules->saveConfig($class, $data) $modules->saveConfig($class, $data, $value = null)	`bool`	Save provided configuration data for the given module

Additional methods and properties

In addition to the methods and properties above, Modules also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

$modules API variable / Modules class

Loads and manages all modules in ProcessWire.

Common

Manipulation

Configuration

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news