Skip to content

ECA token generate event

Plugin ID: eca_base:eca_token_generate

Available since: 2.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.

Fires when a token matching the configured pattern is encountered during Drupal's token replacement process. This allows providing dynamic token values on demand.

Performance consideration

Token replacement happens very frequently across the system (emails, paths, fields, etc.). Keep ECA reactions lightweight to avoid performance issues.

Fields

Name of token — config key: token_name

Example: mygroup:value. Wildcards are supported, e.g. to react upon all "mygroup" tokens: mygroup:* Please provide the token name only, without brackets.

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

The token pattern to react upon (e.g., mygroup:value). Supports wildcards: mygroup:* reacts to all tokens in the 'mygroup' group.