Build form

Available since: 1.0.0

Provided tokens

Token	Description
[form]	The current form. Alias: current_form
[form:id]	The form ID.
[form:base_id]	The form base ID.
[form:operation]	The form operation.
[form:mode]	The form mode.
[form:triggered]	The form field name that triggered the form event.
[form:values]
[form:values:FIELD_NAME]	The field value for each of the named fields.
[form:num_errors]	The number of form errors.
[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 during form building, corresponding to Drupal's hook_form_alter(). This is the earliest form event in the lifecycle and the best place for adding or modifying form elements, changing field properties, and restructuring the form.

Tip

This event fires both during the initial GET request (form rendering) and during POST requests (form rebuilds).

Fields

Restrict by form ID

The form ID can be mostly found in the HTML <form> element as "id" attribute.

Comma-separated list of form IDs. You can use either the HTML form ID (with hyphens) or the Drupal machine name (with underscores). Matching also works on the base form ID (e.g., node_form matches all node entity forms regardless of bundle).

Restrict by entity type ID

Example: node, taxonomy_term, user

Only fires for entity forms. Restricts to the specified entity type (e.g., node, taxonomy_term, user).

Tip

When left empty along with bundle and operation, the event also fires for non-entity forms.

Restrict by entity bundle

Example: article, tags

Only applies to entity forms. Restricts to the specified bundle (e.g., article, tags). Comma-separated for multiple values.

Restrict by operation

Example: default, save, delete

Only applies to entity forms. Restricts to the specified form operation (e.g., default, edit, delete). Comma-separated for multiple values.