Located in file /wire/core/ModulesFiles.php
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ModulesFiles class also inherits all the methods and properties of: ModulesClass and Wire.
Common
| Name | Return | Summary | |
|---|
ModulesFiles::compile() ModulesFiles::compile($moduleName) ModulesFiles::compile($moduleName, string $file = '', $namespace = null) | string bool | Compile and return the given file for module, if allowed to do so | |
ModulesFiles::findModuleFiles() ModulesFiles::findModuleFiles(string $path) ModulesFiles::findModuleFiles(string $path, bool $readCache = false, int $level = 0) | array | Find new module files in the given $path | |
ModulesFiles::getDebugData() ModulesFiles::getDebugData() ModulesFiles::getDebugData() | (nothing) | | |
ModulesFiles::getModuleFile() ModulesFiles::getModuleFile($class) ModulesFiles::getModuleFile($class, $options = []) | bool string | Get the path + filename (or optionally URL) for module | |
ModulesFiles::getModuleLanguageFiles() ModulesFiles::getModuleLanguageFiles($module) ModulesFiles::getModuleLanguageFiles($module) | array | Get module language translation files | |
ModulesFiles::includeModuleFile() ModulesFiles::includeModuleFile(string $file, string $moduleName) ModulesFiles::includeModuleFile(string $file, string $moduleName) | bool | Include the given filename | |
ModulesFiles::moduleFileExt() ModulesFiles::moduleFileExt(string $class) ModulesFiles::moduleFileExt(string $class, int $setValue = null) | int | Get or set module file extension type (1 or 2) | |
ModulesFiles::setConfigPaths() ModulesFiles::setConfigPaths(string $moduleName, string $path) ModulesFiles::setConfigPaths(string $moduleName, string $path) | (nothing) | Setup entries in config->urls and config->paths for the given module | |
Additional methods and properties
In addition to the methods and properties above, ModulesFiles also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.236