ECA token generate event¶
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 value of the HX-Target request header. |
[htmx:trigger] |
The value of the HX-Trigger request header. |
[htmx:trigger_name] |
The value of the HX-Trigger-Name request header. |
[htmx:current_url] |
The value of the HX-Current-URL request header. |
[htmx:prompt] |
The value of the HX-Prompt request header. |
[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-
Example: mygroup:value. Wildcards are supported, e.g. to react upon all "mygroup" tokens: mygroup:* Please provide the token name only, without brackets.
The token pattern to react upon (e.g.,
mygroup:value). Supports wildcards:mygroup:*reacts to all tokens in the 'mygroup' group.