$templates->fileModified() method

Hook called when a Template detects that its file has changed

Note that the hook is not called until something in the system (like a page render) asks for the template’s filename. That’s because it would not be efficient for PW to check the file for every template in the system on every request.

Available since version 3.0.141.

Usage

$templates->fileModified(Template $template);

Arguments

NameType(s)Description
templateTemplate

Hooking $templates->fileModified(…)

You can add your own hook events that are executed either before or after the $templates->fileModified(…) 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 $templates->fileModified(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

  // Get values of arguments sent to hook (and optionally modify them)
  $template = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $template);
});

Hooking after

The 'after' hooks are called immediately after each $templates->fileModified(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

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

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

  // Get values of arguments sent to hook (if needed)
  $template = $event->arguments(0);

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

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

$templates methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #527
    In the 527th issue of ProcessWire Weekly we'll check out what's new in the core this week, introduce a new third party module called Lister Calculator, and more. Read on!
    Weekly.pw / 15 June 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani