$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.236

Latest news

  • ProcessWire Weekly #543
    In the 543rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a couple of new third party modules — both authored by Bernhard Baumrock — and more. Read on!
    Weekly.pw / 5 October 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 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.