function hook_field_purge_field

Same name in other branches
  1. 7.x modules/field/field.api.php \hook_field_purge_field()
  2. 9 core/modules/field/field.api.php \hook_field_purge_field()
  3. 10 core/modules/field/field.api.php \hook_field_purge_field()
  4. 11.x core/modules/field/field.api.php \hook_field_purge_field()

Acts when a field is being purged.

In field_purge_field(), after the field definition has been removed from the system, the entity storage has purged stored field data, and the field info cache has been cleared, this hook is invoked on all modules to allow them to respond to the field being purged.

Parameters

$field: The field being purged.

Related topics

1 invocation of hook_field_purge_field()
field_purge_field in core/modules/field/field.purge.inc
Purges a field record from the database.

File

core/modules/field/field.api.php, line 412

Code

function hook_field_purge_field(\Drupal\field\Entity\FieldConfig $field) {
    \Drupal::database()->delete('my_module_field_info')
        ->condition('id', $field->id())
        ->execute();
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.