Get a module, get module information, and much more ($modules API variable as a function)

This function behaves the same as the $modules API variable, though does support an optional shortcut argument for getting a module.

Example

$modules = modules(); // Simply get $modules API var
$module = modules()->get('ModuleName'); // Get a module
$module = modules('ModuleName'); // Shortcut to get a module

Usage

// basic usage
$modules = modules();

// usage with all arguments
$modules = modules(string $name = '');

Arguments

NameType(s)Description
name (optional)string

Optionally retrieve the given module name

Return value

Modules Module ConfigurableModule null


Functions 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

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