form

Renders an HTML form that sends out an email to the passed email address, and saves the message to the database, so the user can find it under ‘Messages’ in the site dashboard. Inside the 'form' tag, the 'submitted_form_fields' object will be available.

Arguments

The form tag accepts the following arguments:

for
The Plate object that represents the form. (Required)

to
The email address where the message is sent. (Required)
This can be:

  1. A string containing one email address, or multiple comma-separated email addresses.

  2. An array containing strings of individual email addresses.

subject

The subject that is used for the email sent to the email filled in at to. (Not required, default: 'Message sent from %{site}')

See https://plate.atlassian.net/wiki/spaces/DOCS/pages/30245050/register+form+confirmation+field for the subject of the confirmation email.

error_msg
The error message that is used in the ‘request’ object (alert attribute) when the form is invalid and doesn’t get sent. (Not required, default: ‘Something went wrong while sending the message.’)

success_msg
Same as error_msg, but for the message when the form does send (request attribute: notice). (Not required, default: ‘Thank you for your message. We will reply as soon as possible.’)

success_url
The url where the user is redirected to after a successful form submission. (Not required, by default the user gets redirected to the page where the submitted form was located)

enable_recaptcha(accepted values: true, skip_js)
Inserts an invisible Captcha (Google reCaptcha v3) inside the form, to prevent the form being used for spam. Set the value to 'true' for a regular implementation. If you need to handle the Captcha token generation yourself, set the value to 'skip_js'. Read the tutorial to learn how to do this. 

Note that Plate does not add the credits for Google for the use of their ReCaptcha system. It is your own responsibility to add credits for Google on your page if you enable ReCaptcha.

Note2 You need to add {% include "recaptcha_scripts" %} somewhere on the page that has the form on it. The form will not be submitted if the scripts are not included on the page! (go to docs about the include tag)

Examples

Input:

1 2 3 4 5 6 7 8 {% form for: form, to: form.email, success_url: form.success_page_link %} {% for field in form.field_lines %} {% include field %} {% endfor %} <div> <input type="submit" > </div> {% endform %}

Output:

1 2 3 4 <form action="/form_messages" method="post" accept-charset="utf-8"> <!-- Fields --> <div><input type="submit" value="Send"></div> </form>

Every other attribute that you pass will be parsed as HTML attribute in the HTML form-tag.

Input:

1 {% form class: "contact-form" %}

Output:

1 2 3 <form action="/form_messages" method="post" accept-charset="utf-8" class="contact-form"> <!-- Fields --> </form>

 

submitted_form_fields object

Inside the 'form' block, you have access to the 'submitted_form_fields' object. This is a liquid object, representing all the (non-file) fields that were submitted. This allows you to keep your form fields filled when a validation error occurred.

For example, you can use this object when rendering a form field, as follows:

1 2 3 4 5 6 {% form ... %} {% for field in form.fields %} <input type="{{field.type}}" name="{{field.name | form_input_name}}" value="{{submitted_form_fields[field.name]}}"/> {% register_form_field field.name %} {% endfor %} {% endform %}

 

By setting the value of the input field to the value in the 'submitted_form_fields' object, this input field will retain its value when the form is rendered again after a validation error on submitting the form.