ModulesFiles::getModuleFile() method

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

Usage

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

// usage with all arguments
$bool = $modulesFiles->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.

ModulesFiles methods and properties

API reference based on ProcessWire core version 3.0.244

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