$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 as optimization to omit file_exists() checks (default=false).
  • 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.125

Twitter updates

  • New post: This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new Page if() method— More
    15 February 2019
  • New post: ProcessWire 3.0.125 has several useful new Sanitizer methods & options, plus new ways to access them directly from the Input API variable. This makes handling user input even easier than before. Plus updates to our i18n functions & API docs— More
    25 January 2019
  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019

Latest news

  • ProcessWire Weekly #249
    In the 249th issue of ProcessWire Weekly we're going to walk you through the latest core updates (ProcessWire 3.0.126), introduce a new third party module called Page Access Releasetime, and pick a new site of the week. Read on!
    Weekly.pw / 16 February 2019
  • ProcessWire 3.0.126 core updates
    This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new $page->if() method. 
    Blog / 15 February 2019
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK