You are here

Home » API reference » Drupal 10 » field.api.php

function hook_field_purge_field in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/field/field.api.php \hook_field_purge_field()
  2. 7 modules/field/field.api.php \hook_field_purge_field()
  3. 9 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

Field API bulk data deletion
Cleans up after Field API bulk deletion operations.
Hooks
Define functions that alter the behavior of Drupal core.
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 407
Field API documentation.

Code

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