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)
stringThe 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.184

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #385
    In the 385th issue of ProcessWire Weekly we'll cover the latest weekly update from Ryan, check out a new fieldtype module called Page Reference Context Data, and more. Read on!
    Weekly.pw / 25 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer