$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

NameType(s)Description
classstring, Module

Module or module name

dataarray, 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;
});

See Also


$modules methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020
  • ProcessWire 3.0.165 core updates (master and dev branch) and reCAPTCHA for FormBuilder module— More
    21 August 2020

Latest news

  • ProcessWire Weekly #331
    In the 331st issue of ProcessWire Weekly we're going to check out the latest core and Pro module updates (ProcessWire 3.0.166, ProCache 4.0.1, and Form Builder v44), introduce the Wireframe API module, and more. Read on!
    Weekly.pw / 12 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK