You are here

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

function hook_entity_field_values_init in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_field_values_init()
  2. 9 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_field_values_init()

Acts when initializing a fieldable entity object.

This hook runs after a new entity object or a new entity translation object has just been instantiated. It can be used to set initial values, e.g. to provide defaults.

Parameters

\Drupal\Core\Entity\FieldableEntityInterface $entity: The entity object.

See also

hook_ENTITY_TYPE_field_values_init()

Related topics

Entity CRUD, editing, and view hooks
Hooks used in various entity operations.
Hooks
Define functions that alter the behavior of Drupal core.
1 invocation of hook_entity_field_values_init()
ContentEntityStorageBase::initFieldValues in core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php
Initializes field values.

File

core/lib/Drupal/Core/Entity/entity.api.php, line 2165
Hooks and documentation related to entities.

Code

function hook_entity_field_values_init(\Drupal\Core\Entity\FieldableEntityInterface $entity) {
  if ($entity instanceof \Drupal\Core\Entity\ContentEntityInterface && !$entity->foo->value) {
    $entity->foo->value = 'some_initial_value';
  }
}