ModulesInfo class

Located in file /wire/core/ModulesInfo.php

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

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
ModulesInfo::checkModuleVersion(Module $module)
None

Check the module version to make sure it is consistent with our moduleInfo

 
ModulesInfo::clearModuleInfoCache()
None

Clear the module information cache

 
ModulesInfo::getDebugData()
None 
ModulesInfo::getModuleInfo($class)
array

Returns an associative array of information for a Module

 
ModulesInfo::getModuleInfoAll()
array

Get info arrays for all modules indexed by module name

 
ModulesInfo::getModuleInfoExternal(string $moduleName)
array

Retrieve module info from ModuleName.info.json or ModuleName.info.php

 
ModulesInfo::getModuleInfoInternal($module)
array

Retrieve module info from internal getModuleInfo function in the class

 
ModulesInfo::getModuleInfoProperty($class, string $property)
mixed null

Get just a single property of module info

 
ModulesInfo::getModuleInfoSystem(string $moduleName)
array

Retrieve module info for system properties: PHP or ProcessWire

 
ModulesInfo::getModuleInfoVerbose($class)
array

Returns a verbose array of information for a Module

 
ModulesInfo::getNamespaces()
array

Get an array of all unique, non-default, non-root module namespaces mapped to directory names

 
ModulesInfo::moduleInfoCacheEmpty()
bool

Is the module info cache empty?

 
ModulesInfo::moduleInfoCacheHas(int $moduleID)
bool

Does the module info cache have an entry for given module ID?

 
ModulesInfo::moduleVersionChanged($module, $fromVersion, $toVersion)
None

Module version changed

 
ModulesInfo::modulesLastVersions()
string null array

@param int|null $id


Can also be used as property: ModulesInfo::modulesLastVersions
 
ModulesInfo::saveModuleInfoCache()
None

Save the module information cache

 

Properties

NameReturnSummary 
ModulesInfo::moduleInfoCache array 
ModulesInfo::moduleInfoCacheUninstalled array 
ModulesInfo::moduleInfoCacheVerbose array 
ModulesInfo::moduleInfoVerboseKeys array 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.252