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

Latest news

  • ProcessWire Weekly #548
    In the 548th issue of ProcessWire Weekly we're going to check out a couple of new third party modules, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 9 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • 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