$modules->isConfigurable() method

Is the given module configurable?

This method can be used to simply determine if a module is configurable (yes or no), or more specifically how it is configurable.

Return value details

If module is configurable via external configuration file:

  • Returns string of full path/filename to ModuleName.config.php file

If module is configurable because it implements a configurable module interface:

  • Returns boolean true if module is configurable via the static getModuleConfigInputfields() method. This particular method is compatible with all past versions of ProcessWire.
  • Returns integer 2 if module is configurable via the non-static getModuleConfigInputfields() and requires no arguments.
  • Returns integer 3 if module is configurable via the non-static getModuleConfigInputfields() and requires $data array.
  • Returns integer 4 if module is configurable via the non-static getModuleConfigInputfields() and requires InputfieldWrapper argument.
  • Returns integer 19 if module is configurable via non-static getModuleConfigArray() method.
  • Returns integer 20 if module is configurable via static getModuleConfigArray() method.

If module is not configurable:

  • Returns boolean false if not configurable

This method is named isConfigurableModule() in ProcessWire versions prior to to 3.0.16.

Available since version 3.0.16.

Examples

// Determine IF a module is configurable
if($modules->isConfigurable('HelloWorld')) {
  // Module is configurable
} else {
  // Module is NOT configurable
}
// Determine HOW a module is configurable
$configurable = $module->isConfigurable('HelloWorld');
if($configurable === true) {
  // configurable in a way compatible with all past versions of ProcessWire
} else if(is_string($configurable)) {
  // configurable via an external configuration file
  // file is identifed in $configurable variable
} else if(is_int($configurable)) {
  // configurable via a method in the class
  // the $configurable variable contains a number with specifics
} else {
  // module is NOT configurable
}

Usage

// basic usage
$bool = $modules->isConfigurable($class);

// usage with all arguments
$bool = $modules->isConfigurable($class, bool $useCache = true);

Arguments

NameType(s)Description
classModule, string

Module name

useCache (optional)bool

Use caching? This accepts a few options:

  • Specify boolean true to allow use of cache when available (default behavior).
  • Specify boolean false to disable retrieval of this property from getModuleInfo (forces a new check).
  • Specify string interface to check only if module implements ConfigurableModule interface.
  • Specify string file to check only if module has a separate configuration class/file.

Return value

bool string int

See details about return values in method description.


$modules methods and properties

API reference based on ProcessWire core version 3.0.135

Twitter updates

  • New post: A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email— More
    19 July 2019
  • New post: Version 3.0.135 of ProcessWire on the dev branch focuses on some .htaccess updates, adds clarity to debug mode, and improves upon the installer— More
    5 July 2019
  • 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

Latest news

  • ProcessWire Weekly #271
    In the 271st issue of ProcessWire Weekly we're going to introduce two brand new WireMail modules, a new Textformatter module from BitPoet, and a brand new markup module from Chris Thomson. Read on!
    Weekly.pw / 20 July 2019
  • Two new WireMail modules and using Gmail with PW
    A look at two new WireMail modules for sending email, plus details on how you can configure ProcessWire to use Gmail for sending email.
    Blog / 19 July 2019
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani