Skip to content

Entity reference field selection

Plugin ID: content_entity:reference_selection

Available since: 1.0.0

Provided tokens

Token Description
[user] The current user.
Alias: current_user
[htmx] Information about the current HTMX request.
[htmx:is_request] Whether the current request was sent by HTMX ("1" or "0").
[htmx:boosted] Whether the current request was boosted by HTMX ("1" or "0").
[htmx:history_restore] Whether the current request is for HTMX history restoration ("1" or "0").
[htmx:target] The identifier of the element the response is targeted at.
[htmx:trigger] The identifier of the element that triggered the request. On Drupal 11 this is the element id, on Drupal 12 and later it is the CSS selector that htmx 4 sends. Prefer "trigger_name", which means the same thing on both.
[htmx:trigger_name] The name attribute of the element that triggered the request, or empty if it has none. This has the same meaning on all supported Drupal versions.
[htmx:source] The CSS selector of the element that triggered the request, for example button[name="first_item"]. Empty on Drupal 11, which does not send this information.
[htmx:request_type] Whether the request targets a full page or a fragment: "full" or "partial". Empty on Drupal 11, which does not send this information.
[htmx:current_url] The URL of the page the request was sent from.
[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.

Reacts when entity reference field of specific content entities are selected.

Fields

Type (and bundle) — config key: type

Type: select · Required: no · Default: _all

Allowed values depend on the configuration of the target site.

Value format: <entity_type_id> <bundle>, space separated. Use _all as a wildcard in either position.

This field provides a list with all created content entities and its bundles. You can also select -any-, if you want to react to all types or bundles. In configuration, the value is a single string holding the entity type ID and the bundle separated by one space, for example node article, where the wildcard _all stands for -any- in either position. See Authoring models as configuration.

Restrict by field (machine name) — config key: field_name

The machine name of the field to restrict the event trigger.

Type: textfield · Required: no · Default: empty string

The machine name of the entity reference field to react to. Leave empty to react to all entity reference fields using the ECA handler.

Token name holding the selection — config key: token_name

The name of the token to hold the selection. Please provide the token name only, without brackets.

Type: textfield · Required: no · Default: empty string

The token name to hold the selection results. After ECA actions run, the entities in this token become the referenceable entities.