$modules->getConfig() method

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

NameType(s)Description
classstring, Module
property (optional)string

Optionally just get value for a specific property (omit to get all config)

Return value

array string int float

Module 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.137

Twitter updates

  • ProcessWire 3.0.142 has a lot of updates but the biggest is the addition of custom fields support for file and image fields. In this post, we take a closer look at that, and also outline all of the new features in the just-released FormBuilder v40— More
    11 October 2019
  • This week’s dev branch version brings you improvements to ProcessWire’s input->cookie API variable, plus it adds the ability to modify system URLs and paths at runtime. This post also includes some examples to demonstrate just how useful this can be— More
    20 September 2019
  • New post: This week we’ll take a look at a new version of FormBuilder that's on the way (with a screencast), as well as the latest version of the core: ProcessWire 3.0.140— More
    6 September 2019

Latest news

  • ProcessWire Weekly #283
    The 283rd issue of ProcessWire Weekly introduces ProcessWire 3.0.142 and FormBuilder v40, highlights some conference content, and features a new weekly poll continuing with the #processwireworks theme. Read on!
    Weekly.pw / 12 October 2019
  • ProcessWire 3.0.142 core updates
    This latest version of the core on the dev branch has a lot of updates, bnd the biggest is the addition of custom fields support for file and image fields. In this post, we take a closer look and also outline all of the new features in the just-released FormBuilder v40.
    Blog / 11 October 2019
  • 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