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

Twitter updates

  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020
  • If you haven't seen it yet, be sure to check out this great infographic by @teppokoivula in ProcessWire Weekly #294— How ProcessWire professionals work—the results of our recent weekly polls summarised: weekly.pw/issue/294/#how…
    3 January 2020
  • Today we have a new master version released, 3.0.148! There are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we take a closer look at what’s new, how to upgrade, & more— More
    3 January 2020

Latest news

  • ProcessWire Weekly #297
    In the 297th issue of ProcessWire Weekly we're going to check out the latest core updates (ProcessWire 3.0.149) and introduce a new third party module called StaticWire. Read on!
    Weekly.pw / 18 January 2020
  • ProcessWire 3.0.148 new master
    Today we have a new master version released, version 3.0.148! The last master version was 3.0.123, so there are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we’ll take a closer look at what’s new, how to upgrade, and more.
    Blog / 3 January 2020
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.