You are here

public function EntityFormInterface::setEntity in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Entity/EntityFormInterface.php \Drupal\Core\Entity\EntityFormInterface::setEntity()
  2. 9 core/lib/Drupal/Core/Entity/EntityFormInterface.php \Drupal\Core\Entity\EntityFormInterface::setEntity()

Sets the form entity.

Sets the form entity which will be used for populating form element defaults. Usually, the form entity gets updated by \Drupal\Core\Entity\EntityFormInterface::submit(), however this may be used to completely exchange the form entity, e.g. when preparing the rebuild of a multi-step form.

Parameters

\Drupal\Core\Entity\EntityInterface $entity: The entity the current form should operate upon.

Return value

$this

1 method overrides EntityFormInterface::setEntity()
EntityForm::setEntity in core/lib/Drupal/Core/Entity/EntityForm.php
Sets the form entity.

File

core/lib/Drupal/Core/Entity/EntityFormInterface.php, line 58

Class

EntityFormInterface
Defines an interface for entity form classes.

Namespace

Drupal\Core\Entity

Code

public function setEntity(EntityInterface $entity);