function hook_entity_load in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_load()
2. 7 modules/system/system.api.php \hook_entity_load()

Act on entities when loaded.

This is a generic load hook called for all entity types loaded via the entity API.

hook_entity_storage_load() should be used to load additional data for content entities.

Parameters

\Drupal\Core\Entity\EntityInterface[] $entities: The entities keyed by entity ID.

string $entity_type_id: The type of entities being loaded (i.e. node, user, comment).

See also

hook_ENTITY_TYPE_load()

Related topics

2 functions implement hook_entity_load()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

entity_crud_hook_test_entity_load in core/modules/system/tests/modules/entity_crud_hook_test/entity_crud_hook_test.module

Implements hook_entity_load().

views_entity_test_entity_load in core/modules/views/tests/modules/views_entity_test/views_entity_test.module

Implements hook_entity_load().

1 invocation of hook_entity_load()

EntityStorageBase::postLoad in core/lib/Drupal/Core/Entity/EntityStorageBase.php

Attaches data to entities upon loading.

File

core/lib/Drupal/Core/Entity/entity.api.php, line 1032

Hooks and documentation related to entities.

Code

function hook_entity_load(array $entities, $entity_type_id) {
  foreach ($entities as $entity) {
    $entity->foo = mymodule_add_something($entity);
  }
}