Skip to content

Entity: load

Plugin ID: eca_token_load_entity

Available since: 1.0.0

Load a single entity from current scope or by certain properties, and store it as a token.

Fields

Name of token — config key: token_name

Provide the name of a token that holds the loaded entity. Please provide the token name only, without brackets.

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

Load entity from — config key: from

Loads the entity from the given list and/or properties below.
When using the "Defined by token" option, make sure there is a token with this name: eca_token_load_entity_from

Type: select · Required: no · Default: current

Allowed values: current, id, properties, _eca_token, ''

Entity type — config key: entity_type

The type of the entity to be loaded.
When using the "Defined by token" option, make sure there is a token with this name: eca_token_load_entity_entity_type

Type: select · Required: no · Default: _none

Allowed values depend on the configuration of the target site.

Value format: An entity type ID available on the target site, for example node, user or taxonomy_term.

Entity ID — config key: entity_id

The ID of the entity to be loaded.

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

Revision ID — config key: revision_id

The revision ID of the entity to be loaded.

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

Property values — config key: properties

A key-value list of raw field values of the entity to load. This will only be used when loading by properties is selected above. Only an entity that the current user is allowed to view will be loaded. Supports YAML format. Example:
field_mynumber: 1
. When using tokens and YAML altogether, make sure that tokens are wrapped as a string. Example: title: "[node:title]"
This field supports tokens.

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

Language — config key: langcode

The language code of the entity to be loaded.
When using the "Defined by token" option, make sure there is a token with this name: eca_token_load_entity_langcode

Type: select · Required: no · Default: _interface

Allowed values depend on the configuration of the target site.

Value format: A language code enabled on the target site, for example en. The special value _interface means the current interface language.

Load latest revision — config key: latest_revision

Whether loading the latest revision or not.

Type: checkbox · Required: no · Default: false

Load unchanged values — config key: unchanged

Whether loading the unchanged values of fields or not.

Type: checkbox · Required: no · Default: false

Entity — config key: object

Provide the token name of the entity that this action should operate with. Please provide the token name only, without brackets.

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

See also: Tokens being forwarded