$modules->getModuleInfo() method

Returns an associative array of information for a Module

The array returned by this method includes the following:

  • id (int): module database ID.
  • name (string): module class name.
  • title (string): module title.
  • version (int): module version.
  • icon (string): Optional icon name (excluding the "fa-") part.
  • requires (array): module names required by this module.
  • requiresVersions (array): required module versions–module name is key, value is array($operator, $version).
  • installs (array): module names that this module installs.
  • permission (string): permission name required to execute this module.
  • autoload (bool): true if module is autoload, false if not.
  • singular (bool): true if module is singular, false if not.
  • created (int): unix-timestamp of date/time module added to system (for uninstalled modules, it is the file date).
  • installed (bool): is the module currently installed? (boolean, or null when not determined)
  • configurable (bool|int): true or positive number when the module is configurable.
  • namespace (string): PHP namespace that module lives in.

The following properties are also included when "verbose" mode is requested. When not in verbose mode, these properties are present but blank:

  • versionStr (string): formatted module version string.
  • file (string): module filename from PW installation root, or false when it can't be found.
  • core (bool): true when module is a core module, false when not.
  • author (string): module author, when specified.
  • summary (string): summary of what this module does.
  • href (string): URL to module details (when specified).
  • permissions (array): permissions installed by this module, associative array ('permission-name' => 'Description').
  • page (array): definition of page to create for Process module (see Process class)

The following properties appear only for "Process" modules, and only if specified by module. See the Process class for more details:

  • nav (array): navigation definition
  • useNavJSON (bool): whether the Process module provides JSON navigation
  • permissionMethod (string|callable): method to call to determine permission
  • page (array): definition of page to create for Process module

Example

// example of getting module info
$moduleInfo = $modules->getModuleInfo('InputfieldCKEditor');

// example of getting verbose module info
$moduleInfo = $modules->getModuleInfoVerbose('MarkupAdminDataTable');

Usage

// basic usage
$array = $modules->getModuleInfo($class);

// usage with all arguments
$array = $modules->getModuleInfo($class, array $options = []);

Arguments

NameType(s)Description
classstring, Module, int

Specify one of the following:

  • Module object instance
  • Module class name (string)
  • Module ID (int)
  • To get info for ALL modules, specify * or all.
  • To get system information, specify ProcessWire or PHP.
  • To get a blank module info template, specify info.
options (optional)array

Optional options to modify behavior of what gets returned

  • verbose (bool): Makes the info also include verbose properties, which are otherwise blank. (default=false)
  • minify (bool): Remove non-applicable and properties that match defaults? (default=false, or true when getting all)
  • noCache (bool): prevents use of cache to retrieve the module info. (default=false)

Return value

array

Associative array of module information

See Also


$modules methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020

Latest news

  • ProcessWire Weekly #332
    In the 332nd issue of ProcessWire Weekly we'll cover the latest core updates, introduce some new and updated ProcessWire resources, and more. Read on!
    Weekly.pw / 19 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer