We're off to DotAll 2022 in Brooklyn NY (plus a little extra sightseeing time). Our support will be limited.

Rendering Forms#

Showing the form in your templates is the first step in getting Formie's forms working with your site. Rendering an entire form will include all pages, rows, columns, fields, buttons, captchas and more.

The easiest way to output your form is to use the handle of a form:

{{ craft.formie.renderForm('contactForm') }}

You can optionally provide a Form object in the same way.

{% set form = craft.formie.forms({ handle: 'contactForm' }).one() %}

{{ craft.formie.renderForm(form) }}

If you're using a Form Field in an entry or other element, you can get the Form object from that field. For example, you might have a Form field with the handle myFormFieldHandle added to a specific entry element.

{% set form = entry.myFormFieldHandle.one() %}

{{ craft.formie.renderForm(form) }}

Render Options#

A second argument to renderForm() allows you to pass in variables used as Render Options.

{% set renderOptions = {
    fieldNamespace: 'myCustomNamespace',

    themeConfig: {
        form: {
            attributes: {
                class: 'my-custom-class',
                'data-new-attribute': 'some-value',
            },
        },
    },
} %}

{{ craft.formie.renderForm('contactForm', renderOptions) }}

Override Form Settings#

You can dynamically override any settings for the form using form.setSettings().

{% set form = craft.formie.forms.handle('contactForm').one() %}

{% do form.setSettings({
    {# Set the redirect URL to something static #}
    redirectUrl: 'https://google.com',

    {# Or, set the redirect URL to include a query param to the submission #}
    redirectUrl: form.getRedirectUrl() ~ '?submissionId={id}',
}) %}

{{ craft.formie.renderForm(form) }}

The above would override the redirect URL for the form, regardless of what is defined in the form's settings. See the Form Settings docs for a full list of available settings to override.

For more fine-grained control over rendering of a form, see Rendering Pages and Rendering Fields.

Previous ← Available Variables Next Rendering Pages →

Get started with Formie

Available for Craft 4. Get it from the plugin store.