ProcessTemplate::fieldRemoved() method

For hooks to listen to when a field is removed from a template

Usage

$processTemplate->fieldRemoved(Field $field, Template $template);

Arguments

NameType(s)Description
fieldField
templateTemplate

Hooking ProcessTemplate::fieldRemoved(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('ProcessTemplate::fieldRemoved', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ProcessTemplate = $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)
  $field = $event->arguments(0);
  $template = $event->arguments(1);

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

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

ProcessTemplate methods and properties

API reference based on ProcessWire core version 3.0.244

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer