ModulesConfigs class

Located in file /wire/core/ModulesConfigs.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 ModulesConfigs class also inherits all the methods and properties of: ModulesClass and Wire.

Common

Name	Return	Summary
ModulesConfigs::getDebugData() ModulesConfigs::getDebugData() ModulesConfigs::getDebugData()	None
ModulesConfigs::isConfigable() ModulesConfigs::isConfigable($class) ModulesConfigs::isConfigable($class, bool $useCache = true)	`bool` `int` `string`	Indicates whether module accepts config settings, whether interactively or API only
ModulesConfigs::setModuleConfigData() ModulesConfigs::setModuleConfigData(Module $module) ModulesConfigs::setModuleConfigData(Module $module, $data = null, $extraData = null)	`bool`	Populate configuration data to a ConfigurableModule

Manipulation

Name	Return	Summary
ModulesConfigs::saveConfig() ModulesConfigs::saveConfig($class, $data) ModulesConfigs::saveConfig($class, $data, $value = null)	`bool`	Save provided configuration data for the given module

Configuration

Name	Return	Summary
ModulesConfigs::getConfig() ModulesConfigs::getConfig($class) ModulesConfigs::getConfig($class, string $property = '')	`array` `string` `int` `float`	Given a module name, return an associative array of configuration data for it
ModulesConfigs::getModuleEditUrl() ModulesConfigs::getModuleEditUrl($className) ModulesConfigs::getModuleEditUrl($className, bool $collapseInfo = true)	`string`	Return the URL where the module can be edited, configured or uninstalled
ModulesConfigs::isConfigurable() ModulesConfigs::isConfigurable($class) ModulesConfigs::isConfigurable($class, bool $useCache = true)	`bool` `string` `int`	Is the given module interactively configurable?
ModulesConfigs::saveConfig() ModulesConfigs::saveConfig($class, $data) ModulesConfigs::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, ModulesConfigs also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.253