$modules->get() method

Get the requested Module

  • If the module is not installed, but is installable, it will be installed, instantiated, and initialized. If you don't want that behavior, call $modules->isInstalled('ModuleName') as a conditional first.
  • You can also get/load a module by accessing it directly, like $modules->ModuleName.
  • To get a module with additional options, use $modules->getModule($name, $options) instead.

Example

// Get the MarkupAdminDataTable module
$table = $modules->get('MarkupAdminDataTable');

// You can also do this
$table = $modules->MarkupAdminDataTable;

Usage

$module = $modules->get($key);

Arguments

NameType(s)Description
keystring, int

Module name (also accepts database ID)

Return value

Module _Module null

Returns a Module or null if not found

Exceptions

Method can throw exceptions on error:

  • WirePermissionException - If module requires a particular permission the user does not have

See Also


$modules methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #522
    In the 522nd issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called File Mover, and more. Read on!
    Weekly.pw / 11 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • 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.