ECA Block¶
Plugin ID: eca_render:block
Available since: 1.1.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. |
[BLOCK_CONTEXT] |
The value of the block context under the given name of the token. |
[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 an ECA Block is rendered. Each ECA block event creates a corresponding block that can be placed in Drupal's Block Layout UI.
Populate the render array using ECA actions to control the block's output. Block context values (such as the current node or user) are available as tokens when the block is placed in a context that provides them.
Fields¶
Block name— config key:block_name-
This block name will be used for being identified in the list of available blocks.
Type:
textfield· Required: yes · Default: empty stringThe human-readable name for this block. This name will appear in the block listing UI and is used to generate the machine name.