function FieldItemInterface::postSave

Same name in other branches
  1. 9 core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::postSave()
  2. 8.9.x core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::postSave()
  3. 11.x core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::postSave()

Defines custom post-save behavior for field values.

This method is called during the process of saving an entity, just after values are written into storage. This is useful mostly when the business logic to be implemented always requires the entity identifier, even when storing a new entity. For instance, when implementing circular entity references, the referenced entity will be created on pre-save with a dummy value for the referring entity identifier, which will be updated with the actual one on post-save.

In the rare cases where item properties depend on the entity identifier, massaging logic will have to be implemented on post-save and returning TRUE will allow them to be rewritten to the storage with the updated values.

Parameters

bool $update: Specifies whether the entity is being updated or created.

Return value

bool Whether field items should be rewritten to the storage as a consequence of the logic implemented by the custom behavior.

1 method overrides FieldItemInterface::postSave()
FieldItemBase::postSave in core/lib/Drupal/Core/Field/FieldItemBase.php
Defines custom post-save behavior for field values.

File

core/lib/Drupal/Core/Field/FieldItemInterface.php, line 216

Class

FieldItemInterface
Interface for entity field items.

Namespace

Drupal\Core\Field

Code

public function postSave($update);

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