$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.200

Twitter updates

  • New post: Multi-language field translation export/import — In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire… More
    5 August 2022
  • Weekly update, July 29: Continuing upgrades to ProcessWire’s comments system and FormBuilder, along with a working example—More
    29 July 2022
  • Weekly update for July 22– Looking back at what web development was like in the year 2000. Plus some more discussion on the path from CKEditor 4 to CkEditor 5 in ProcessWire: More
    22 July 2022

Latest news

  • ProcessWire Weekly #430
    In the 430th issue of ProcessWire Weekly we're going to check out some brand new third party modules, a new site of the week, and more. Read on!
    Weekly.pw / 7 August 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer