EntityFormMode

Defines the entity form mode configuration entity class.

Form modes allow entity forms to be displayed differently depending on the context. For instance, the user entity form can be displayed with a set of fields on the 'profile' page (user edit page) and with a different set of fields (or settings) on the user registration page. Modules taking part in the display of the entity form (notably the Field API) can adjust their behavior depending on the requested form mode. An additional 'default' form mode is available for all entity types. For each available form mode, administrators can configure whether it should use its own set of field display settings, or just replicate the settings of the 'default' form mode, thus reducing the amount of form display configurations to keep track of.

Plugin annotation

@ConfigEntityType(
  id = "entity_form_mode",
  label = @Translation("Form mode"),
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "label",
    "targetEntityType",
    "cache",
  }
)

Hierarchy

• class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
  • class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
    • class \Drupal\Core\Entity\EntityDisplayModeBase implements EntityDisplayModeInterface
      • class \Drupal\Core\Entity\Entity\EntityFormMode implements EntityFormModeInterface

See also

\Drupal\Core\Entity\EntityManagerInterface::getAllFormModes()

\Drupal\Core\Entity\EntityManagerInterface::getFormModes()

File

core/lib/Drupal/Core/Entity/Entity/EntityFormMode.php, line 40

Namespace

Drupal\Core\Entity\Entity

Members