Skip to main content

Forms QueriesImproved in 5.13+

The Forms query allows you to retrieve a list of Freeform forms in your Twig templates. You can display all forms, filter by specific form groups, or use the results to build navigation menus, dashboards, or form selection lists.

​Parameters

​groupNew in 5.13+

Filters the results by one or more form groups. You can pass the group ID, the group label, or an array of either. If the group parameter isn't provided, all forms available on the current site will be returned.

​Examples

​Get All Forms

{% set forms = freeform.forms() %}

{% for form in forms %}
  <p>{{ form.name }}</p>
{% endfor %}

​Display Form IconsNew in 5.17.3+

Each returned Form object provides form.icon for its configured Craft icon name and form.iconSvg for Twig-safe SVG markup:

<ul>
  {% for form in freeform.forms %}
    <li>
      {% if form.iconSvg %}
        <span aria-hidden="true">{{ form.iconSvg }}</span>
      {% endif %}
      {{ form.name }}
    </li>
  {% endfor %}
</ul>

No |raw filter is needed. form.iconSvg returns null on Craft 4 or when the icon is blank, invalid, or unavailable. Add your own icon dimensions and color styles. These properties are also available when retrieving a single form with freeform.form().

​Get Forms by Group IDNew in 5.13+

{% set formsInGroup = freeform.forms({ group: 3 }) %}

{% for form in formsInGroup %}
  <p>{{ form.name }}</p>
{% endfor %}

​Get Forms by Multiple GroupsNew in 5.13+

{% set forms = freeform.forms({ group: [1, 2, 3] }) %}

{% for form in forms %}
  <p>{{ form.name }}</p>
{% endfor %}

​Get Forms by Group LabelNew in 5.13+

{% set forms = freeform.forms({ group: 'Marketing Forms' }) %}

{% for form in formsInGroup %}
  <p>{{ form.name }}</p>
{% endfor %}

​Display Forms Grouped by Form GroupNew in 5.13+

When combining with the formGroups query, you can display a list of all forms, grouped by form groups.

<ul class="freeform-form-groups">
  {% for group in freeform.formGroups %}
    <li>
      <h3>{{ group.label }}</h3>

      {% set formsInGroup = freeform.forms({ group: group.id }) %}
      {% if formsInGroup|length %}
        <ul>
          {% for form in formsInGroup %}
            <li>{{ form.name }} ({{ form.handle }})</li>
          {% endfor %}
        </ul>
      {% else %}
        <p><em>No forms in this group.</em></p>
      {% endif %}
    </li>
  {% endfor %}
</ul>
Page Feedback