Fieldtype::deleteTemplateField() method

Delete the given Field from all pages using the given template, without loading those pages.

ProcessWire will use this method rather than deletePageField in cases where the quantity of items to delete is high (above 200 at time this was written). However, if your individual Fieldtype defines it's own ___deletePageField method (separate from the one above) then it'll still get used.

This was added so that mass deletions can happen without loading every page, which may not be feasible when dealing with thousands of pages.

Usage

$bool = $fieldtype->deleteTemplateField(Template $template, Field $field);

Arguments

NameType(s)Description
templateTemplate
fieldField

Return value

bool


Hooking Fieldtype::deleteTemplateField(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

Fieldtype methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 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

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull