FileCompilerModule::install() method

Perform any installation procedures specific to this module, if needed.

Usage

$fileCompilerModule->install();

Hooking FileCompilerModule::install()

You can add your own hook events that are executed either before or after the FileCompilerModule::install() method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each FileCompilerModule::install() method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('FileCompilerModule::install', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FileCompilerModule = $event->object;

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

The 'after' hooks are called immediately after each FileCompilerModule::install() method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('FileCompilerModule::install', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FileCompilerModule = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

FileCompilerModule methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #581
    The 581st issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 28 June 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • 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