$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

Exceptions

Method can throw exceptions on error:

  • WireException - when a module exists but has no means of returning module info

See Also


$modules methods and properties

API reference based on ProcessWire core version 3.0.125

Twitter updates

  • New post: This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new Page if() method— More
    15 February 2019
  • New post: ProcessWire 3.0.125 has several useful new Sanitizer methods & options, plus new ways to access them directly from the Input API variable. This makes handling user input even easier than before. Plus updates to our i18n functions & API docs— More
    25 January 2019
  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019

Latest news

  • ProcessWire Weekly #249
    In the 249th issue of ProcessWire Weekly we're going to walk you through the latest core updates (ProcessWire 3.0.126), introduce a new third party module called Page Access Releasetime, and pick a new site of the week. Read on!
    Weekly.pw / 16 February 2019
  • ProcessWire 3.0.126 core updates
    This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new $page->if() method. 
    Blog / 15 February 2019
  • 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.