Skip to documentation content

Form Submit

Form Submit

The form submit object and methods for form submission.

{{ form_submit }}

Properties
Properties of {{ form_submit }} objects
Name Type Description
object_type string Will always be form_submit
is_valid boolean True if this references a published form_submit
guid string The unique identifier for this form_submit
value string Contains the same value as guid
form_guid string The unique identifier of the form that was submitted
form {{ form }} Reference to the form that was submitted
submission_url string Full URL where the form was submitted from
date_submitted {{ time }} The date and time when the form was submitted
field_id string The identifier for this field
label string The label for this field
output string The default output that the form_submit produces when output directly to the template. The default output may change at any time. Template developers should avoid using this and should handle the output of form submissions themselves

{% form_submit %}

{% form_submit output_to_template? [[var, set, or assign]? variable]? output_to_template? = value %}
Parameters
output_to_template optionalflag
If included the {% form_submit %} will be output directly to the template.
var, set, or assign optionalkeyword
Optional. Specify either "var", "set" or "assign" to change which scope this {% form_submit %} is stored on. "var" is the default behavior.
variable_name optionalvariable
Specify a variable name in order to save this form_submit to a variable. If not specified, it will be output to the template instead.
value requiredexpression
Should evaluate to an object of type form_submit, or the name or guid of one. May use liquid filters.

Fetches a single {{ form_submit }}.