ModulesFiles::getModuleFile()

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

Name Type(s) Description

Name	Type(s)	Description
`$class`	`string` `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.

$class

string 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.253