Plugin Settings

Solspace Freeform includes several settings that allow you to customize your form management experience. To adjust your settings, click the Settings menu item while in the Freeform plugin, or go to Settings > Plugins > Freeform and click the settings link.

Watch the Installing and Configuring Freeform Course tutorial on CraftQuest!

If you wish to override these settings with a config file, please see the Config Overrides documentation.

The settings allow you to adjust:

General Settings

General Settings

  • Custom Plugin Name Pro
    • Override the plugin name by specifying your own here.
  • Show Composer Tutorial
    • Enable this to show the interactive tutorial again in Composer. This setting disables again when the tutorial is completed or skipped.
  • Default view
    • This setting allows you to specify which Freeform page should be loaded by default when clicking the Freeform navigation link. Options are:
      • Dashboard (default)
      • Forms
      • Submissions
  • Display Order of Fields in Composer
    • The display order for the list of available fields in Composer:
      • Field type, Field name (alphabetical)
      • Field name (alphabetical)
  • Render HTML inside Composer & Submissions view?
    • Live rendering HTML in HTML blocks, field labels and option labels inside the Composer interface can sometimes conflict with Freeform's display of the form preview inside the control panel. In cases like these, you'll need to disable this setting to prevent HTML from rendering automatically.
  • AJAX Enabled for Forms by Default
    • By default, the Enable AJAX feature checkbox will be checked for new forms.
  • Default Formatting Template
    • The default formatting template for new forms. All newly created forms will have this formatting template selected by default.
  • Include Default Freeform Formatting Templates
    • Disable this to hide the default Freeform formatting templates in the Formatting Template options list inside Composer.
  • Remove Newlines from Textareas for Exporting
    • Enable this to have newlines removed from Textarea fields in submissions when exporting.
  • Fill Form Values from the GET Query String
    • Enable this to be able to fill form field values from a GET query string in URI.
    • To use this feature, make sure that the query in the URI matches the handle of the field(s) in the form, e.g. ?firstName=Bob&myRatingField=3.
  • Disable Submit Button on Form Submit?
    • Enable this to automatically disable the form's submit button when the user submits the form. This will prevent the form from double-submitting.
  • Automatically Scroll to Form on Errors and Multipage forms?
    • Enable this to have Freeform use JS to automatically scroll the page down to the form upon submit when there are errors or the form is continuing to the next page in multipage forms.
  • Freeform Javascript Insertion Location
    • The location of where you want Freeform to insert it's scripts for form and field functionality (such as spam protection and advanced field types).
      • Page Footer
      • Inside Form
      • None (manually load the JS instead)
  • Automatically Purge Submission Data Pro
    • If you wish to have Freeform automatically purge submission data after a specified number of days, enable this setting and specify the number of days after submission date it should purge submissions.

      WARNING

      Enabling this and saving this settings page will result in purging beginning, and cannot be undone.

      • Days After Submission Date to Purge
        • Select the number of days after submissions have been submitted for Freeform to begin automatically purging. This process will only run every hour, and only when Freeform is accessed on the front end in templates or in the control panel.

Formatting Templates

  • Directory Path
    • When using custom formatting templates for your forms, you'll need to specify where your Twig-based templates are stored.
    • Provide a relative path to craft root to your custom form templates directory.
      • E.g. freeform_formatting_templates
    • To add a starter example template, click the "Add a sample template" button, and then edit the template after.

Formatting Templates

Email Templates

  • This area is for users that wish to use Twig-based HTML template files for email notifications. See Email Notifications documentation for more information about implementation.
  • Directory Path
    • Provide a relative path to craft root to your custom form templates directory.
      • E.g. freeform_notifications
    • To add a starter example template, click the "Add a sample template" button, and then edit the template after.
  • Default Email Notification Creation Method
    • Select which storage method to use when creating new email notifications with Add New Notification option in Composer.
      • Database Entry - Use CP-based database template editor.
      • Template File - Use Twig-based HTML template files.

Email Templates

Statuses

  • This area allows you to manage and create new statuses for your forms.
    • You can set the default status to be set for all forms here.

Statuses

Create a Status

Demo Templates

  • Allows you to install the Demo Templates to get Freeform up and running on the front end with just a couple clicks!

Spam Settings

For more information about Freeform's spam protection features, visit the Spam Protection documentation.

  • Freeform Honeypot
    • Freeform includes its own Honeypot spam protection feature. This is enabled by default, but can be disabled here.
  • Javascript Enhancement
    • Enable this to use Freeform's built-in Javascript enhancement for the Honeypot feature. This will require users have JS enabled for their browser and help fight spambots more aggressively.
  • Spam Protection Behavior
    • Select the behavior you'd like Freeform to take when it detects a submission as being spam:
      • Simulate successful submission (recommended)
      • Display error messages (not recommended)
      • Reload form
  • Use Spam Folder
    • When enabled, all submissions caught by the honeypot or blocked email addresses, keywords and IP addresses will be flagged as spam and stored in the database, but available to manage in a separate menu inside Freeform. When paired with reCAPTCHA and its Failure Behavior setting set to Send to Freeform Spam Folder, failed submissions will also end up in the Spam Folder.
  • Automatically Purge Spam Submissions
    • If you wish to have Freeform automatically purge submissions flagged as spam after a specified number of days, enable this setting and specify the number of days after submission date it should purge spammy submissions.

    WARNING

    Enabling this and saving this settings page will begin the purging of submissions flagged as spam, and cannot be undone.

    • Days After Submission Date to Purge
      • Select the number of days after spammy submissions have been submitted for Freeform to begin automatically purging. This process will only run every hour, and only when Freeform is accessed on the front end in templates or in the control panel.
  • Block Email addresses
    • Enter email addresses you would like blacklisted from being used in Email fields. Use * for wildcard, and separate multiples on new lines.
    • Display errors about blocked email(s) under each email field?
      • Enable this if you'd like field-based errors to display under the email field(s) that the user has entered blocked emails for. Not recommended for regular use, but helpful if trying to troubleshoot submission issues.
  • Block Keywords
    • Enter keywords you would like blacklisted from being used in all text and textarea fields. Use * for wildcard, and separate multiples on new lines.
    • Display errors about blocked keyword(s) under each text/textarea field?
      • Enable this if you'd like field-based errors to display under the field(s) that the user has entered blocked keywords for. Not recommended for regular use, but helpful if trying to troubleshoot submission issues.
  • Block IP addresses
    • Enter IP addresses you would like blacklisted. Separate multiples on new lines.
  • Form Submission Throttling
    • Globally (affecting all users) prevent spam or attacks by limiting the number of times all forms can be submitted within a given timeframe.

Spam Settings

reCAPTCHA

  • Enable reCAPTCHA
    • Enable this setting and fill in the reCAPTCHA Site Key and Secret Key to enable reCAPTCHA for Freeform.
    • Visit Google reCAPTCHA site to register your site and get your Site Key and Secret Key.
  • reCAPTCHA type
    • Choose which type of reCAPTCHA you wish to use:
      • reCAPTCHA v2 Checkbox
      • reCAPTCHA v2 Invisible Pro
      • reCAPTCHA v3 Pro
  • Failure Behavior
    • Display error
      • An error saying the reCAPTCHA is required.
    • Send to Freeform Spam Folder
      • Any failed attempt at completing the reCAPTCHA will allow the submission through, but flag it as spam and it'll end up in the Freeform Spam Folder.
  • reCAPTCHA Minimum Score (reCAPTCHA v3 only)
    • Enter the minimum score needed to pass the reCAPTCHA v3 test.
      • We recommend starting with 0.5 and see how that goes.
      • A 0.0 score means that it's almost certain a bot, while a 1.0 score means it's a user.

To add reCAPTCHA v2 Checkbox to your forms, open up each form in CP Composer and drag over the reCAPTCHA special field anywhere you like into your form layout.

TIP

reCAPTCHA v2 Invisible and reCAPTCHA v3 will automatically load a reCAPTCHA icon in the bottom right corner of your site containing the form. This is required by Google's terms of service. There are CSS workarounds if you wish to locate the icon to the left side of the browser page, etc.

reCAPTCHA Settings

API Integrations

  • Mailing Lists Pro
    • The Mailing Lists area allows you to manage your mailing list API integrations.
    • Mailing list integrations are set up here and are globally available to all forms, but are configured per form inside the Composer interface.
    • To connect to a mailing list API, click the New Mailing List Integration at the top right.

Connect Mailing List

  • CRM Pro
    • The CRM area allows you to manage your CRM (Customer Relationship Management) API integrations.
    • CRM integrations are set up here and are globally available to all forms, but are configured per form inside the Composer interface.
    • To connect to a CRM API, click the New CRM Integration at the top right.
      • View the CRM API Integration documentation for more information about setting up and configuring.

Connect CRM

  • Payments Pro

    • This area allows you to configure and manage Stripe Payments for your forms.
    • The Stripe Payments integration is set up here and are globally available to all forms, but are configured per form inside the Composer interface.
    • To create a new Stripe payment setup, click the New Payment Integration at the top right.
  • Webhooks Pro

    • This area allows you to configure and manage Slack, Zapier and generic Webhooks for your forms.
    • The Webhooks integrations are set up and completely managed here. You specify which form(s) each Webhook applies to, etc.
    • To create a new Webhook, click the New Webhook at the top right.

Error Log

In as many cases as possible, Freeform attempts to write errors and issues to its own error log. The file is physically located in the same place as the Craft logs (/storage/logs/freeform.log), but can be conveniently viewed inside the Error Log page inside Freeform Settings area (Freeform -> Settings -> Error Log). If there are no logged errors, the Error Log page will not show any errors, and you will likely not see the Freeform error log file.

Error Log

Last Updated: 7/23/2019, 1:28:42 AM