FileCompilerModule class

Located in file /wire/core/FileCompilerModule.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 FileCompilerModule class also inherits all the methods and properties of: WireData and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
FileCompilerModule::compile(string $data)
string arrayThe compile method processes the contents of a file 
FileCompilerModule::compileMarkup(string $data)
stringCompile a section of markup 
FileCompilerModule::getModuleConfigInputfields(InputfieldWrapper $inputfields)
(nothing)Configure the FileCompiler module 
FileCompilerModule::getSourceFile()
stringGet the source file (full path and filename) that this module is acting upon 
FileCompilerModule::init()
(nothing)Optional method to initialize the module. 
FileCompilerModule::install()
(nothing)Perform any installation procedures specific to this module, if needed.
FileCompilerModule::isAutoload()
(nothing) 
FileCompilerModule::isSingular()
(nothing) 
FileCompilerModule::runOrder int Order that the module executes in relative to other FileCompiler modules.  
FileCompilerModule::setSourceFile($file)
(nothing) 
FileCompilerModule::uninstall()
(nothing)Perform any uninstall procedures specific to this module, if needed.

Additional methods and properties

In addition to the methods and properties above, FileCompilerModule also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Newest forum posts

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 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.