ECA Extra field¶
Available since: 1.1.0
Provided tokens
| Token | Description |
|---|---|
[event] |
The event. |
[event:machine_name] |
The machine name of the ECA event. |
[session_user] |
The user account that dispatched the event, regardless if ECA is processing models under a different account. This is only available if ECA is configured to always run under a specific account. |
[entity] |
The entity of the event. |
[ENTITY_TYPE] |
The entity of the event under the name of its entity type. |
Defines a custom extra field that appears in the entity's Manage Display or Manage Form Display UI. The extra field can be reordered and placed in regions like any real field.
Populate the render array using ECA actions to control the field's output. The extra field name, entity type, and bundle are configured in this event.
Fields¶
Restrict by entity type ID-
Example: node, taxonomy_term, user
The entity type this extra field should appear on (e.g.,
node). When empty, the field is registered for all entity types. Restrict by entity bundle-
Example: article, tags
The bundle this extra field should appear on (e.g.,
article). When empty, the field is registered for all bundles of the specified entity type. Machine name of the extra field-
The machine name of the extra field. Must only container lowercase alphanumeric characters and underscores.
The machine name for this extra field. Must contain only lowercase alphanumeric characters and underscores.
Label of the extra field-
The human-readable label of the extra field.
The human-readable label shown in Manage Display or Manage Form Display.
Description-
An optional description for this extra field, shown in field management interfaces.
Display type-
Choose whether this extra field appears in the entity's view display (rendered output) or form display (edit form).
Weight-
The default weight order. Must be an integer number.
The default weight (sort order) of this extra field. Can be overridden by dragging in the Manage Display UI.
Default visible-
When enabled, the extra field will be automatically displayed by default.
When enabled, the extra field will be visible by default without requiring manual activation in Manage Display.