$modules->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 = $modules->getModuleInfoVerbose($class);

// usage with all arguments
$array = $modules->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


$modules methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • 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.