$modules->getModuleFile() method

Get the path + filename (or optionally URL) for this module

Usage

// basic usage
$bool = $modules->getModuleFile($class);

// usage with all arguments
$bool = $modules->getModuleFile($class, $options = []);

Arguments

NameType(s)Description
classstring, Module

Module class name or object instance

options (optional)array, bool

Options to modify default behavior:

  • getURL (bool): Specify true if you want to get the URL rather than file path (default=false).
  • fast (bool): Specify true to omit file_exists() checks (default=false).
  • guess (bool): Manufacture/guess a module location if one cannot be found (default=false) 3.0.170+
  • Note: If you specify a boolean for the $options argument, it is assumed to be the $getURL property.

Return value

bool string

Returns string of module file, or false on failure.


$modules methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #582
    The 582nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 5 July 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani