FieldtypeRepeater::deleteField() method

Delete the given field, which implies: drop the table $field->table

This should only be called by the Fields class since fieldgroups_fields lookup entries must be deleted before this method is called.

With the repeater, we must delete the associated fieldgroup, template and parent as well

Usage

$bool = $fieldtypeRepeater->deleteField(Field $field);

Arguments

NameType(s)Description
fieldField

Field object

Return value

bool

True on success, false on DB delete failure.


Hooking FieldtypeRepeater::deleteField(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

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

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

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

FieldtypeRepeater methods and properties

API reference based on ProcessWire core version 3.0.244

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits