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

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits