Freeform Documentation

Learn the basics, and get to know Freeform inside and out.

Freeform 1.x Docs

Field type

Freeform includes a Freeform Forms fieldtype, which allows you to assign/relate forms to other element types such as Craft Entries.

Here's an overview on how to use this fieldtype:

Creating a Freeform Form field #

Creating a Freeform Form field is done just like any other fieldtype, here's an overview of the process:

  1. Go to the Settings area in Craft control panel. Click on Fields.
  2. Click the New field button in the top right corner.
  3. Name the field as you wish. For example: Related Form with a handle of relatedForm.
  4. For the Field Type option, select Freeform Form from the list.
  5. Selection Label is the text that will appear on the button which opens the Freeform Form selection pop-up dialog.
  6. Click the Save button in the top right corner to save the new field.

Your Freeform Form field is now available to be assigned to other sections.

Create New Fieldtype

How the Fieldtype works #

The Freeform Form fieldtype lets the user assign any Freeform form to any element: a section Entry, Categories, Assets, etc.

Using Fieldtype

Template Properties #

The following are template properties are available for the Form fieldtype:

  • name #
    • Outputs the name of the form
  • handle #
    • Outputs the handle of the form
  • id #
    • Outputs the unique ID of the form
  • description #
    • Outputs the description of the form
  • render() #
    • Outputs the full form, rendering it with the Formatting Template specified in Composer for the form.

Usage in Templates #

An example of template code you would use to display a Freeform form (with field handle of myFreeformfieldname) that is attached to a Craft Entry would look something like this:

{% for entry in craft.entries.section('news').limit(10) %}
    <div class="entry">
        <h2><a href="{{ entry.url }}">{{ entry.title }}</a></h2>
        {{ entry.summary }}
        {% if entry.myFreeformfieldname is defined and entry.myFreeformfieldname is not empty %}
            <h3>{{ entry.myFreeformfieldname.name }}</h3>
            {{ entry.myFreeformfieldname.render() }}
        {% endif %}
    </div>
{% endfor %}

If you'd like to automatically pass content from another element (such as a Craft Entry) into Freeform field(s), you'd have to use the overrideValues property inside your formatting template.

For example, if you want to pass a title of an entry to a Freeform field, and the entry slug was in the second segment of your URL, you should set that in your formatting template. Also be sure to include a hidden Freeform field in your form (in this case called entryTitle). Your formatting template code might look something like this:

{% set entry = craft.entries.slug(craft.app.request.getSegment(2)).first() %}

{{ form.renderTag({
    overrideValues: { entryTitle: entry.title }
}) }}