$modules->saveConfig() method

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 = $modules->saveConfig($class, $data);

// usage with all arguments
$bool = $modules->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

bool

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

Hooking $modules->saveConfig(…)

You can add your own hook events that are executed either before or after the $modules->saveConfig(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $modules->saveConfig(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Modules::saveConfig', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $modules = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $class = $event->arguments(0);
  $data = $event->arguments(1);
  $value = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $class);
  $event->arguments(1, $data);
  $event->arguments(2, $value);
});

Hooking after

The 'after' hooks are called immediately after each $modules->saveConfig(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Modules::saveConfig', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $modules = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $class = $event->arguments(0);
  $data = $event->arguments(1);
  $value = $event->arguments(2);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});