function FieldableEntityStorageInterface::purgeFieldData

Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php \Drupal\Core\Entity\FieldableEntityStorageInterface::purgeFieldData()
  2. 8.9.x core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php \Drupal\Core\Entity\FieldableEntityStorageInterface::purgeFieldData()
  3. 11.x core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php \Drupal\Core\Entity\FieldableEntityStorageInterface::purgeFieldData()

Purges a batch of field data.

Parameters

\Drupal\Core\Field\FieldDefinitionInterface $field_definition: The deleted field whose data is being purged.

int $batch_size: The maximum number of field data records to purge before returning, relating to the count of field data records returned by \Drupal\Core\Entity\FieldableEntityStorageInterface::countFieldData().

Return value

int The number of field data records that have been purged.

File

core/lib/Drupal/Core/Entity/FieldableEntityStorageInterface.php, line 43

Class

FieldableEntityStorageInterface
A storage that supports entity types with field definitions.

Namespace

Drupal\Core\Entity

Code

public function purgeFieldData(FieldDefinitionInterface $field_definition, $batch_size);

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