FieldtypeComments::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.

Usage

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

Arguments

NameType(s)Description
fieldField

Field object

Return value

bool

True on success, false on DB delete failure.


Hooking FieldtypeComments::deleteField(…)

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

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

FieldtypeComments methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer