Render: custom form

Plugin ID: eca_render_custom_form

Available since: 1.1.0

Build a custom form using "ECA Form" events.

Fields

Custom form ID — config key: custom_form_id

This custom form ID is being used to identify the form on ECA Form events. It is always prefixed with "eca_custom_". Example: When specified the custom form ID my_custom_form, then it can be identified e.g. on the event Build form using the form ID eca_custom_my_custom_form.

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

Machine name — config key: name

Optionally define a machine name of this render element. It will be made available under that name in the render array of the current event in scope. Nested elements can be set with using "][" brackets, for example details][title.
This field supports tokens.

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

Token name — config key: token_name

Optionally define a token name of this render element. It will be made available under that token name for later usage. Please provide the token name only, without brackets.

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

Element weight — config key: weight

Optionally specify an element weight. The lower the weight, the element appears before other elements having a higher weight.
This field supports tokens.

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

Build mode — config key: mode

When using the "Defined by token" option, make sure there is a token with this name: eca_render_custom_form_mode

Type: select · Required: yes · Default: append

Allowed values: set:clear, set:clear:defined, merge, prepend, append, nothing, _eca_token