Save provided configuration data for the given module
- 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 saveModuleConfigData() 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);Usage
// basic usage
$bool = $modulesConfigs->saveConfig($class, $data);
// usage with all arguments
$bool = $modulesConfigs->saveConfig($class, $data, $value = null);Arguments
| Name | Type(s) | Description |
|---|---|---|
class | string, Module | Module or module name |
data | array, string | Associative array of configuration data, or name of property you want to save. |
value (optional) | mixed, null | If you specified a property in previous arg, the value for the property. |
Return value
boolTrue on success, false on failure
Exceptions
Method can throw exceptions on error:
WireException
Changelog
- 3.0.16 Changed name from the more verbose saveModuleConfigData(), which will still work.
See Also
ModulesConfigs methods and properties
API reference based on ProcessWire core version 3.0.236