$fields->deleteFieldDataByTemplate() method

Physically delete all field data (from the database) used by pages of a given template

This is for internal API use only. This method is intended only to be called by Fieldtype::deleteTemplateField

If you need to remove a field from a Fieldgroup, use Fieldgroup::remove(), and this method will be call automatically at the appropriate time when save the fieldgroup.

Usage

$bool = $fields->deleteFieldDataByTemplate(Field $field, Template $template);

Arguments

NameType(s)Description
fieldField
templateTemplate

Return value

bool

Whether or not it was successful

Exceptions

Method can throw exceptions on error:

  • WireException - when given a situation where deletion is not allowed


Hooking $fields->deleteFieldDataByTemplate(…)

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

$this->addHookBefore('Fields::deleteFieldDataByTemplate', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $fields = $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 $fields->deleteFieldDataByTemplate(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Fields::deleteFieldDataByTemplate', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $fields = $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;
});

$fields methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #522
    In the 522nd issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called File Mover, and more. Read on!
    Weekly.pw / 11 May 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

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH