function field_delete_instance

Marks a field instance and its data for deletion.

Parameters

\Drupal\field\Plugin\Core\Entity\FieldInstance $instance: The field instance.

$field_cleanup: If TRUE, the field will be deleted as well if its last instance is being deleted. If FALSE, it is the caller's responsibility to handle the case of fields left without instances. Defaults to TRUE.

Deprecated

as of Drupal 8.0. Use $instance->delete().

Related topics

Field CRUD API
Creates, updates, and deletes Field API fields, bundles, and instances.
8 calls to field_delete_instance()
BulkDeleteTest::testDeleteFieldInstance in drupal/core/modules/field/lib/Drupal/field/Tests/BulkDeleteTest.php
Verify that deleting an instance leaves the field data items in the database and that the appropriate Field API functions can operate on the deleted data and instance.
BulkDeleteTest::testPurgeField in drupal/core/modules/field/lib/Drupal/field/Tests/BulkDeleteTest.php
Verify that fields are preserved and purged correctly as multiple instances are deleted and purged.
BulkDeleteTest::testPurgeInstance in drupal/core/modules/field/lib/Drupal/field/Tests/BulkDeleteTest.php
Verify that field data items and instances are purged when an instance is deleted.
CommentFieldsTest::testCommentDefaultFields in drupal/core/modules/comment/lib/Drupal/comment/Tests/CommentFieldsTest.php
Tests that the default 'comment_body' field is correctly added.
FieldInstanceCrudTest::testDeleteFieldInstance in drupal/core/modules/field/lib/Drupal/field/Tests/FieldInstanceCrudTest.php
Test the deletion of a field instance.

... See full list

File

drupal/core/modules/field/field.crud.inc, line 331
Field CRUD API, handling field and field instance creation and deletion.

Code

function field_delete_instance(FieldInstance $instance, $field_cleanup = TRUE) {
  $instance
    ->delete($field_cleanup);
}