Given a module name, return an associative array of configuration data for it
- Applicable only for modules that support configuration.
- Configuration data is stored encoded in the database "modules" table "data" field.
Available since version 3.0.16. Use method getModuleConfigData() with same arguments for prior versions (can also be used on any version).
Example
// Getting, modifying and saving module config data
$data = $modules->getConfig('HelloWorld');
$data['greeting'] = 'Hello World! How are you today?';
$modules->saveConfig('HelloWorld', $data);
// Getting just one property 'apiKey' from module config data
@apiKey = $modules->getConfig('HelloWorld', 'apiKey'); Usage
// basic usage
$array = $modules->getConfig($class);
// usage with all arguments
$array = $modules->getConfig($class, string $property = '');Arguments
| Name | Type(s) | Description |
|---|---|---|
class | string, Module | |
property (optional) | string | Optionally just get value for a specific property (omit to get all config) |
Return value
array string int floatModule configuration data, returns array unless a specific $property was requested
Changelog
- 3.0.16 Changed from more verbose name `getModuleConfigData()`, which can still be used.
See Also
$modules methods and properties
API reference based on ProcessWire core version 3.0.236