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

Show $var?             Show args?        

Common

NameReturnSummary 
$modules->configs ModulesConfigs 
$modules->coreModulesDir string 
$modules->coreModulesPath string 
$modules->files ModulesFiles 
$modules->findByInfo($selector)
arrayFind modules by matching a property or properties in their module info 
$modules->findByPrefix(string $prefix)
arrayFind modules matching the given prefix (i.e. “Inputfield”) 
$modules->flags ModulesFlags 
$modules->get($key)
Module _Module nullGet the requested Module 
$modules->getDebugData()
(nothing) 
$modules->getModule($key)
Module _Module null stringGet the requested Module (with options) 
$modules->getModuleFile($class)
bool stringGet the path + filename (or optionally URL) for this module 
$modules->getModuleID($class)
intReturns the database ID of a given module class, or 0 if not found 
$modules->getModuleInfo($class)
arrayReturns an associative array of information for a Module 
$modules->getModuleInfoProperty($class, string $property)
mixed nullGet just a single property of module info 
$modules->getModuleInfoVerbose($class)
arrayReturns a verbose array of information for a Module 
$modules->getModuleLanguageFiles($module)
arrayGet module language translation files 
$modules->info ModulesInfo 
$modules->installableFiles array 
$modules->installer ModulesInstaller 
$modules->isInstalled(string $class)
boolIs the given module name installed? 
$modules->loader ModulesLoader 
$modules->memcache(string $name)
bool array mixed nullSet a runtime memory cache 
$modules->moduleIDs array 
$modules->moduleNames array 
$modules->refreshing bool 
$modules->siteModulesPath string 

Configuration

NameReturnSummary 
$modules->getConfig($class)
array string int floatGiven a module name, return an associative array of configuration data for it 
$modules->getModuleEditUrl($className)
stringReturn the URL where the module can be edited, configured or uninstalled 
$modules->getModuleInstallUrl(string $className)
stringGet URL where an administrator can install given module name 
$modules->isConfigurable($class)
bool string intIs the given module interactively configurable? 
$modules->saveConfig($class, $data)
boolSave 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.225

Latest news

  • ProcessWire Weekly #489
    In the 489th issue of ProcessWire Weekly we'll check out what's new in the core this week, share a brand-new recipe of the week, and more. Read on!
    Weekly.pw / 23 September 2023
  • ProcessWire 3.0.226 new main/master version
    After 8 months in development we are excited to bring you ProcessWire 3.0.226 main/master. This version has a ton of great new features, improvements and optimizations, plus more than 100 issue fixes. This post takes an in-depth look at highlights from this great new version.
    Blog / 25 August 2023
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer