$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.130

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer