$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.133

Twitter updates

  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019
  • New post: This week we’ll take a look at 3 different WEBP image strategies that you can use in ProcessWire 3.0.132+. Then we’ll dive into a major update for the Google Client API module, and finish up by outlining some useful new updates in FormBuilder— More
    31 May 2019
  • New post: This week we've added WEBP support in ProcessWire thanks to a GitHub pull request from Horst Nogajski. This enables you to have highly optimized image output in PW and I think you’ll really like the difference it makes— More
    24 May 2019

Latest news

  • ProcessWire Weekly #266
    In the 266th issue of ProcessWire Weekly we're going to take a closer look at ProcessWire 3.0.133 (dev), introduce a third party module called Repeater Images, and highlight a recently released site belonging to the Australian Antarctic Division. Read on!
    Weekly.pw / 15 June 2019
  • ProcessWire 3.0.133 core updates
    ProcessWire 3.0.133 adds a useful new $page->meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type. Read on for all the details, examples and screenshots.
    Blog / 14 June 2019
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull