ModulesInfo::getModuleInfoVerbose() method

Returns a verbose array of information for a Module

This is the same as what’s returned by Modules::getModuleInfo() except that it has the following additional properties:

  • 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)

Usage

// basic usage
$array = $modulesInfo->getModuleInfoVerbose($class);

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

Arguments

NameType(s)Description
classstring, Module, int

May be class name, module instance, or module ID

options (optional)array

Optional options to modify behavior of what gets returned:

  • noCache (bool): prevents use of cache to retrieve the module info
  • noInclude (bool): prevents include() of the module file, applicable only if it hasn't already been included

Return value

array

Associative array of module information

See Also


ModulesInfo methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #581
    The 581st issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 28 June 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK