Populating Forms

Populate forms when you want to prefill values before rendering.

This is useful when the form should start with known information instead of making someone type it again.

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

{% do craft.formie.populateFormValues(form, {
    firstName: currentUser.firstName ?? null,
    email: currentUser.email ?? null,
}) %}

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

Standard fields

Most fields accept a simple string value, including text fields, dropdowns, and multi-line text.

{% do craft.formie.populateFormValues(form, {
    textField: 'Some Value',
    dropdownField: 'Another Value',
    multiLineTextField: 'Another long bit of content',
}) %}

Element fields

For element fields such as Entries, Categories, Tags, Users, Products, and Variants, pass an array of element IDs.

{% do craft.formie.populateFormValues(form, {
    entriesField: [123, 5625],
    productsField: [6457],
}) %}

Group

For fields inside a Group field, pass an object keyed by the inner field handles.

{% do craft.formie.populateFormValues(form, {
    groupFieldHandle: {
        text: 'Some Value',
    },
}) %}

Phone

A Phone field can accept either a simple number, or an object with both the number and country code.

{% do craft.formie.populateFormValues(form, {
    phoneFieldHandle: '0412345678',
    phoneWithCountryFieldHandle: {
        number: '0412345678',
        country: 'AU',
    },
}) %}

Recipients

Recipients fields can be populated with one email or many, depending on the display type.

{% do craft.formie.populateFormValues(form, {
    recipientsHidden: '[email protected]',
    recipientsCheckboxes: ['[email protected]', '[email protected]'],
    recipientsRadio: '[email protected]',
    recipientsDropdown: '[email protected]',
}) %}

For checkbox, radio, and dropdown display types, Formie uses internal IDs in the HTML rather than exposing the real email address in the page source.

Repeater

To populate a Repeater field, pass an array of objects. Each object becomes one repeater block.

{% do craft.formie.populateFormValues(form, {
    repeaterFieldHandle: [
        {
            textField: 'Some Value',
            dropdownField: 'Option 1',
        },
        {
            textField: 'Another Value',
            dropdownField: 'Option 2',
        },
    ],
}) %}

Table

To populate a Table field, pass an array of row objects keyed by the table column handles.

{% do craft.formie.populateFormValues(form, {
    tableFieldHandle: [
        {
            textColumnHandle: 'Some Value',
            dropdownColumnHandle: 'Option 1',
        },
        {
            textColumnHandle: 'Another Value',
            dropdownColumnHandle: 'Option 2',
        },
    ],
}) %}

Forcing values

populateFormValues() works by setting initial values before render. That means it behaves much like a default value on a field.

If someone already has an incomplete submission, those fields may already have saved values, even if they are blank. In that case, your populated values will not replace them automatically.

When you do need to override an existing incomplete submission, pass true as the third argument.

{% do craft.formie.populateFormValues(form, {
    myHiddenField: 'This value can never be changed',
    entriesField: [123, 456],
}, true) %}

This is most useful for values that should always be set from the template, such as hidden fields or relationship fields that should not drift.

URL pre-population

Fields can also be populated from the URL using each field's Prefill Query Parameter setting.

For example, a URL like this:

http://mysite.com/contact-us?first_name=Peter&last_name=Sherman&[email protected]&content=I want to know more!

can be mapped onto fields by setting each field's Prefill Query Parameter to the query parameter you want it to use.

For checkbox fields, you can pass either one value or many:

?checks_field=SomeValue
?checks_field[]=FirstValue&checks_field[]=SecondValue

For element fields, pass the selected element ID or IDs:

?entries_field=1234
?entries_field[]=1234&entries_field[]=5678