Freeform for Craft

4.x

• 5.x✓ Latest
• 4.x
• 3.xRetired
• 2.xRetired
• 1.xRetired

Plugin Store

Integrations

# Element Connections Pro

Hire Us

# Craft Entries

If you'd like to map Freeform submission data to Craft Entries, while in the form builder for an existing form, do the following:

1. Click on the chain icon button in the Property Editor column at the top right.
2. For the Type dropdown, select Entries.
3. For the Section dropdown, select the section you'd like to map to.
4. For the Entry Type dropdown, select the section entry type you'd like to map to.
5. If you'd like new entries created from Freeform submissions to be disabled when submitted, check the Disable entries? checkbox.
6. Map compatible Craft fields to Freeform fields in the Field mapping table.
   • See Field Mapping Guidelines for more info.

# Craft Users

If you'd like to map Freeform submission data to Craft User, essentially creating a User Registration form, while in the form builder for an existing form, do the following:

1. Click on the chain icon button in the Property Editor column at the top right.
2. For the Type dropdown, select Users.
3. For the User Group checkboxes, select the user group(s) you'd like to map to.
   • All user groups (including ones with access to CP) will show here. Exercise extreme caution if allowing users to self-register for accounts that can access the Craft CP!
4. If you'd like new users created from Freeform submissions to not yet be activated (and receive the Craft User Activation email) when submitted, check the Activate users? checkbox. If you'd like to manually approve registrations (please see warning below) and suppress the email notification to users, uncheck the Send activation email? checkbox.

   DANGER

   When using a manual Admin approving approach, it's still possible for a Pending user to circumvent this process if a Forgot Password form is available to them, as Craft currently does not have a concept of Admin approval only, and allows users to verify their account either through an email notification or using a Forgot Password form.

5. Map compatible Craft fields to Freeform fields in the Field mapping table.
   • See Field Mapping Guidelines for more info.
   • You will need to use the special Password field for mapping passwords to User passwords. The Freeform Password field will NOT save any password data in the Freeform database tables.

# Solspace Calendar Events

Freeform's Element Connections feature supports mapping to Solspace Calendar Events, providing you have the Calendar plugin installed of course. If you'd like to map Freeform submission data to Calendar Events, while in the form builder for an existing form, do the following:

1. Click on the chain icon button in the Property Editor column at the top right.
2. For the Type dropdown, select Calendar Events.
3. For the Calendar dropdown, select the calendar you'd like to map to.
4. If you'd like new events created from Freeform submissions to be disabled when submitted, check the Disable events? checkbox.
5. If you'd like all new events created through Freeform to be considered "all day" events, check the All day? checkbox.
   • When checked, this will allow you to have users just choose a Start date and End date for events and not worry about time, but you will not be able to allow any users at all to specify a time for some events.
   • If you wish to have users specify times in addition to dates of their events, leave this unchecked. If you wish to offer the ability for users to set that an event is "all day", you can map a Freeform checkbox field to the All Day field in the field mapping table.
6. Map compatible Craft fields to Freeform fields in the Field mapping table.
   • See Field Mapping Guidelines for more info.

# Field Mapping Guidelines

There are some obvious limitations with field mapping, as Freeform does not have anything like a Matrix or Table field, etc. Most traditional fields that are similar to each other should be able to correctly map to each other however. This list is a work in progress, and we'll continue to update it as we make improvements:

• Freeform Checkbox fields can be mapped to Craft's Checkbox field (with just 1 option) as well as the Lightswitch field. Just make sure the value and casing in Freeform matches.
• Craft Date/Time fields should be mapped to with the following format: Y-m-d H:i:s (aka YYYY-MM-DD HH:MM:SS or just YYYY-MM-DD for Freeform Date & Time fields using Date only).
• Freeform File Upload fields can be mapped to regular Craft Assets fields, as well as the Users Photo field.

# Email Notification Templates

When using the Element Connections feature, you can use the element object to display data from the newly created Craft Element such as ID, title, username, etc.

For example (but not limited to):

• element.id will return the ID of the newly created Element
• element.title will return the title of the newly created Craft Entry
• element.username will return the username of the newly created Craft User

If you have more than 1 element connection for the form, you can use either:

# Editing Elements

Freeform allows you to edit/update existing Craft elements (Entries, Users and Calendar Events currently) by including the elementId parameter in your form. It works by feeding a Freeform form an element ID. If you already have a Freeform form to handle creating Craft elements (e.g. User Registration), it's very likely you'll need to create a new form (or duplicate an existing form as a starting point) for form to update Craft elements (e.g. Edit Profile). When you create a new form, be sure to to set up the Element Connections feature and field mapping, and then in your template, a basic call to it would look something like this:

{{ craft.freeform.form("editCraftUsers").render({
	elementId: craft.app.request.segment(3)
}) }}

Here are some examples of what this might look like for you...

# Allow the currently logged in user to update their own User profile

{% if currentUser %}
	<h2>Update Your Profile</h2>
	{{ craft.freeform.form("editCraftUsers").render({
		elementId: currentUser.id
	}) }}
{% endif %}

# Display a list of Craft Entries and link them to an Edit form

{% set segment2 = craft.app.request.segment(2) %}

{# SAFETY FIRST - LOGGED IN ADMINS ONLY #}
{% if (currentUser) and (currentUser.admin) %}

	<h2>Craft Entries</h2>
	{% set entries = craft.entries()
		.section('mySection')
		.limit(4)
	%}
	<ul>
	{% for entry in entries.all() %}
		<li>
			<a href="{{ siteUrl }}edit-entry/{{ entry.id }}/">{{ entry.title }}</a>
		</li>
	{% endfor %}
	</ul>

	{% if segment2 %}
		<hr />
		{{ craft.freeform.form("editCraftEntries").render({
			elementId: segment2
		}) }}
	{% endif %}

{% endif %}

You could also use a conditional like this to perform a check on users assigned to a specific group:

{% if currentUser.isInGroup('editors') %}{% endif %}