/Drupal 8

function hook_ENTITY_TYPE_prepare_form

hook_ENTITY_TYPE_prepare_form(\Drupal\Core\Entity\EntityInterface $entity, $operation, \Drupal\Core\Form\FormStateInterface $form_state)

Acts on a particular type of entity object about to be in an entity form.

This can be typically used to pre-fill entity values or change the form state before the entity form is built. It is invoked just once when first building the entity form. Rebuilds will not trigger a new invocation.


\Drupal\Core\Entity\EntityInterface $entity: The entity that is about to be shown on the form.

$operation: The current operation.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

See also



Related topics

Entity CRUD, editing, and view hooks
Hooks used in various entity operations.
Define functions that alter the behavior of Drupal core.


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


function hook_ENTITY_TYPE_prepare_form(\Drupal\Core\Entity\EntityInterface $entity, $operation, \Drupal\Core\Form\FormStateInterface $form_state) {
  if ($operation == 'edit') {
    $entity->label->value = 'Altered label';
    $form_state->set('label_altered', TRUE);

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.