{note} This release includes updates to the default Notification Email Templates and updates to what variables are defined by default for the Hidden and Invisible Fields. Please be sure to review your custom Form implementations if you use these features and ensure everything is working as you'd like.
- Added support for Markdown and custom true/false values for Opt-in Field (#216)
- Added support for Opt-in Field in Basic Form Template
- Improved support for Address, Name, Phone, and Opt-in Fields in Notification Email Template (#239)
- Added
striptagsfilter to field values being dynamically output in Notification Email (#227) - Updated default
addFieldVariablesin base Form Templates to only include the most common variables from the Craft_context:craft,now,currentSite,currentUser,siteName,siteUrl,systemName - Updated Email Template to hide plainInput fields in Notification Emails (#240)
- Updated When a Form Entry is saved event to return null and improved logic in Email Template to handle test emails where no mock Entry could be found
- Updated barrelstrength/sprout-base-email requirement v1.0.1
- Fixed scenario where
addFieldVariableswas called in Form Templates more than once - Fixed labels and wrapper div in Opt-in Field template (#235)
- Fixed issue where tab navigation did not scroll with a large number of tabs (#238)
- Fixed label ids in Name Field template (#235)
- Fixed false positives that could occur with Notification Email validation (#100)
- Fixed a Foreign Key issue when migrating from Craft 2 to Craft 3 (drop index needed in a foreign key constraint) (#234)
- Fixed a Foreign Key issue when migrating from Craft 2 to Craft 3 (#234)
- Added barrelstrength/sprout-base-import requirement v1.0.0
- Added resources previously managed in Sprout Base
- Updated settings to implement SproutSettingsInterface
- Updated barrelstrength/sprout-base requirement to v4.0.6
- Added barrelstrength/sprout-base-email requirement v1.0.0
- Added barrelstrength/sprout-base-fields requirement v1.0.0
- Added barrelstrength/sprout-base-reports requirement v1.0.0
- Fixed bug where it does not display form entries when one of the form is deleted
- Fixed bug in Craft 3.1 migration (#226)
- Fixed error when using Number Fields in Craft 3.1 migration
- Improved PostgreSQL compatibility in migrations
- Added initial support for Craft 3.1
- Updated Craft CMS requirement to v3.1.0
- Updated Sprout Base requirement to v4.0.5
- Added International Address Form Field
- Added autocomplete support to base Address Form Field templates
- Updated translation filter to use the category 'site' as templates output front-end content and should be translatable on the front-end #214
- Improved error message when a Form Field is missing from a Field Layout #209
- Updated Entries Relations field from 'Entries (Sprout)' => 'Entries (Sprout Forms)'
- Updated Entries Relations field from 'Forms (Sprout)' => 'Forms (Sprout Forms)'
- Added several assets back to repo that were previously stored in Sprout Base
- Updated barrelstrength/sprout-base to require v4.0.4
- Added placeholder output to regex field #212
- Fixed issue where instructions would not output HTML #208
- Fixed issue where Invisible Field was not processing dynamic values on front-end requests (#205)
- Improved support for migrating from Craft 2 to Craft 3 (#199, #204)
- Fixed consistency of Phone field error message (#201)
- Updated Per-form Form Templates to default to global setting (#193)
- Updated Sprout Base requirement to v4.0.3
- Fixed email notification logic for Craft 2 to Craft 3 migration (#198)
- Fixed namespace naming conflict in PHP 7 (#195)
- Field handles now display when hovering over a field
- Updated Sprout Base requirement to v4.0.2
- Added customize sources support for Form Entries Element Index
- Improved migration for Notification Emails (#189)
- Fixed various Deprecation Warnings (#184)
- Fixed bug in Email Notifications migration
- Updated Sprout Base requirement to v4.0.1
- Updated Sprout Base requirement to v4.0.0
- Removed
from Checkboxes and Opt-in field Form Templates #95 - Updated Form Field getTemplatesPath to be dynamic #98
- Updated Sprout Forms Save Entry Notification Event to return the latest entry as a mock value
- Updated Sprout Base requirement to v3.0.10
- Fixed bug where user was unable to update Opt-in Field message
- Fixed issue where payload was sending empty POST params. #145
- Fixed issue where Email Dropdown field would not render the correct value in Notification Email templates (#171)
- Fixed bug where Name field would not throw error if it was required and submitted blank #172
- Fixed various issues in Notification Email migrations from Craft 2
- Added Opt-In Form Field
- Added support for Sprout Google ReCaptcha Spam Protection
- Added
setEntryvariable
- Improved front-end form editing the
entryvariable is managed in Form Templates when using the displayForm tag
- Fixed Changelog link format
- Improved support in PHP 7.2 (#144)
- Improved Postgres support (#137, #158)
- Improved error messaging if Title Format setting includes an incorrect field handle (#96)
- Updated Sprout Base requirement to v3.0.4
- Fixed Email Dropdown field bug where front-end submissions would save incorrect value in database ([#63])
{warning} This is a recommended upgrade.
- Fixed issue where deleting a Form Field could also delete a field with a matching handle in the global context
- Refactored Save Entry workflow (#135, #139)
- Improved error message when a Form's Title Format value causes a render error
- Updated Sprout Base requirement to v3.0.2
- Fixed bug where validation would not trigger if data was not being saved in the database (#135)
- Fixed a bug where creating a field after deleting a new tab resulted in inaccessible fields in the db (#149)
- Fixed deprecated
includeJstags (#148) - Fixed javascript parse error on Entry Statuses settings page (#140)
- Updated Sprout Base requirement to v3.0.0
- Added support for
defaultBodyfield in Basic Email Template - Improvements in Notification Emails from Sprout Email v4.0.0-beta.1
- Improvements in Reports from Sprout Reports v1.0.0-beta.11
- Updates Form Edit sidebar to use a single column (#122, #118)
- Updated Basic Notification Email Template styles
- Updated Sprout Base requirement to v2.0.10
- Added Form and Entry Element Type migration
- Fixed potential syntax error with Form Notification Email template and SaveEntry Event
- Fixed broken styles introduced in recent Craft update (#122)
- Fixed bug where Sender fields would not validate if using dynamic values (#124)
- Fixed bug where checkboxes field would throw error when displaying on Entry page (#125)
- Added field-specific class name to field wrappers in Form Templates (#112)
- Added status handle filter to Entry Query
- Fixed behavior of Rendering Options in field override templates (#103)
- Fixed bug where Paragraph Field Column Type setting did not validate over 255 characters (#110)
- Fixed bug where the Checkboxes field only saved the value of the final checkbox (#108)
- Fixed issue where custom fields behaved incorrectly on Form Entry Elements (#89)
- Fixed error when moving a field between two tabs (#106)
- Fixed bug when using custom email template overrides #102
- Added support for Email Attachments (#85)
- Added support for tab scrolling when Forms have a large number of tabs (#97)
- Fixed bug where File Upload field did not upload files if the filename already existed (#101)
- Updates Sprout Base to v2.0.3
- Fixed reference to Email Dropdown Field Service
- Fixes release notes warning syntax
{warning} If you have more than one Sprout Plugin installed, to avoid errors use the 'Update All' option.
- Added minVersionRequired as Sprout Forms v2.5.1 (#92)
- Updated Sprout Email Notification Events to extend new BaseNotificationEvent class
- Updated pattern of Report Edit URL
- Updated folder structure
- Moved schema and component definitions to Plugin class
- Moved templates to Sprout Base
- Moved asset bundles to Sprout Base
- Fixed several deprecation errors
- Fixed bug when using CLI (#91, #5)
- Fixed bug where form handle casing could cause error during migration (#84)
- Fixed Notification exception where parameter did not work in PHP 7.2 (#86)
- Fixed migration bug where form content table names could be created with improper casing
- Fixed bug where report data source could return null
- Fixed bug where report migration was not run for existing Sprout Report installations
- Added Notifications powered by Sprout Email
- Added Basic Notification Email Templates integration
- Added Custom Save Entry Event for Notification Emails
- Added Reports powered by Sprout Reports
- Added Sprout Forms Entries Data Source
- Fixed bug when updating from Craft 2
- Fixed bug where a Form Entry could not be deleted
- Fixes bug where user was unable to submit a form if not logged in
- Added support for
craft.sproutForms.entriestag - Added Recent Form Entries Widget
- Added user permissions to Manage, View, and Edit forms
- Fixed various migration bugs
- Fixed bug where "Save as New Form" did not copy all data
- Fixed bug where Tags field did not allow selecting multiple tags
- Fixed icon mask display issue
- Fixed bug where a Form Element would not save properly when using PHP 7.2
- Fixed Form submission error where Sprout Email was being referenced when not present
- Fixed javascript bug that could occur when Sprout Fields was disabled
- Improved translation support
- Updated Accessible Form Templates submit button to use tag
- Removed default CSS options from Accessible Templates
- Disabled required option on PrivateNotes, Invisible, and Hidden fields
- Removed references to legacy notification email fields and logic
- Removed legacy example files
- Updated Basic Templates to support new displayTab and displayField methods
- Fixed bug where cssClasses was always true
- Fixed bug where duplicate captcha could allow duplicates
- Fixed bug where missing resources could disable drag and drop if per-form settings were disabled
- Fixed reference to Sprout Base Importers service
- Fixed Name field label identification
- Added new Drag & Drop Form Builder user interface
- Added support for Reordering Tabs and moving fields between tabs
- Added Front-end Field API
- Added support for fields from Sprout Forms and Sprout Fields in Craft 2
- Added Section Heading, Private Notes, and Custom HTML Fields
- Added International Name Field with single input and multi-input options and autocomplete support
- Added International Phone Field
- Added autocomplete support for Name, Email, and Phone fields
- Added Form Templates API
- Added Accessible Templates Form Templates which include support for several WCAG 2.0 guidelines
- Added Captcha API
- Added support for several Invisible Captcha integrations
- Removed Notes Field in favor of Section Heading, Private Notes, and Custom HTML Fields
- Updated Plain Text to Single Line Field
- Updated Plain Text multiline to Paragraph Field
- Updated Radio Buttons to Multiple Choice Field
- Updated Assets to File Upload Field
- Removed Phone Field with Pattern Mask
- Added support for the Assets filename in Sprout Forms Entries Report integration
- Added support for $criteria->formHandle
- Improved validation for field handles to include reserved words from Entry Model
- Improved translation support
- Fixed bug where getEntryById could return last entry if entryId was null
- Fixed bug where Amazon S3 files could not be attached to a notification email
- Added
Manage Formspermission - Added
View Form EntriesandEdit Form Entriespermissions
- Fixed bug where Forms could be saved with a duplicate slug
- Added support to retrieve Form Entries by
statusHandle - Added translate filter to placeholder text
- Updated Sprout Forms Entry Elements to use SproutForms_EntryElement::getFieldsForElementsQuery
- Fixed bug where
craft.sproutForms.lastEntry()would return null
- Added option to disable saving form submission data to the database globally or on a per-form basis
- Added Support for Email Notifications when using Payload Forwarding
- Added hidden config override
sproutForms->enableEditFormEntryViaFrontEndto make forms editable on the front-end
- Improved support for static translations on tabs and fields
- Improved default settings on install
- Fixed bug in Sprout Import integration settings
- The SproutForms_FormModel variable is now available within tab and field templates
- Updated post variable to be passed as a parameter to the SproutForms_FormsService service
- Updated renderObjectTemplate methods to set safe mode to true
- Fixed javascript error that could occur when some fields were marked as required
- Fixed Sprout Import integration bug with how dateCreated was imported to Form Entries Elements
- Added support for line breaks in default notification email template
- Improved support for Sprout Import
- Fixed errors that could occur on servers running PHP 5.3
- Fixed issue on Sprout Reports integration when the form does not exist.
- Fixed issue on Sprout Reports integration when dates are empty.
- Fixed bug on getAllEntries service method.
- Fixed casing of entry statuses template folder reference
- Added Form Entry Statuses and customizable status workflow
- Added front-end field support for Entries Relations field
- Added front-end field support for Categories Relations field
- Added front-end field support for Tags Relations field
- Added support for S3 Asset uploads and file attachments
- Added option for third-party form submissions to also save a copy of the submission to the Craft database
- Added an advanced settings section to allow customization of which user-facing advanced settings to display
- Improved labeling around custom form template overrides options
- Improved error logging
- Updated form redirect behavior to follow Craft conventions
- Fixed several minor security vulnerabilities
- Added support for Form Entries Explorer chart in PHP 5.3
- Fixed issue where a checkbox field marked as required would require all checkboxes to be selected before validating
- When form validation fails, the displayForm tag now adds focus to the first error in the form
- Improved "Save as new form" behavior
- Fixed method signature compatibility error with FieldsService::saveField() method in PHP7
- Fixed deprecation error introduced in Craft 2.6.2779
- Added support for editing fields via the field modal workflow
- Improved Sprout Reports integration adding support for updating report options on the fly
- Fixed a bug where deleting a Form via the bulk action dropdown didn't delete the Form's related content table
- Fixed issue where Form field input tag data attributes were not wrapped in quotations
- Fixed bug where the Tab name would be repeated before each field in notifications if a Form had more than one tab
- Fixed a bug where Tab names could misbehave if they had blank spaces
- Added Form Entries Explorer Chart
- Added Recent Form Entries Chart dashboard widget
- Added PHP 7 compatibility
- Added support for creating fields via a modal
- Improved workflow around creating new fields and tabs
- Improved sending of notifications via the service layer
- Added 'Save and continue editing' option in the save form dropdown
- Updated default form save behavior to save and redirect to form index page
- Various code cleanup and improved organization
- Fixed error when displaying fields that were not in the content table
- Added form handle validation
- Fixed bug on forms using an Assets field
- Added Recent Form Entries dashboard widget
- Added support for filtering and ordering Form Entries using the
craft.sproutForms.entriestag
- New Forms are now immediately editable
- Fixed broken link in sidebar documentation
- Added support for Form redirects to use relative URLs
- Added support for importing Form and Form Entry Elements using Sprout Import
- Improved messaging around spam protection using Sprout Invisible Captcha
- Added upcoming Sprout Reports Form Entries integration
- Fixed Sprout Email integration where a notification email could default to the most recent entry instead of the most recent entry of a particular form type.
- Fixed issue with notification subject line encoding that could when using PHP Mail protocol.
- Fixed issue where email notification template couldn't be overridden when using custom template overrides.
- Fixed issue where bulk renaming forms titles failed when some special characters were in the title.
- Fixed asset upload bug introduced in Craft 2.5 updates
- Fixed redirect issue (404) after installation
- The entire Control Panel has been updated to work with Craft 2.5
- Added Plugin icon
- Added Plugin description
- Added link to documentation
- Added link to plugin settings
- Added link to release feed
- Added subnav in place of tabs for top level navigation
- Added Sprout Migrate support for SproutForms_Form Element Type
- Added Sprout Migrate support for SproutForms_Entry Element Type
- Form Entry titles on existing entries get updated when Title Format is changed
- Field variables used in Title Format will be updated dynamically if field name is changed
- Improved and standardized display of Sprout plugin info in footer
- Improved errors and messaging on examples page
- Updated emails to use filter_var for validation
- Updated
SproutForms_FormRecord::validateRecipent()method to allow twig syntax - Removed customize source link on Form element index page
- Fixed a bug where setting an id using renderingOptions would output duplicate ids
- Fixed a bug where checkbox field only captured last value
- Fixed a bug where sidebar list stopped showing in Craft 2.5
- Fixed a bug where making field required or removing it would fail in Craft 2.5
- Fixed a bug where Form Entry element types could throw an error on Form Entry
- element index page
- Designers and front-end developers now have 100% control over every form template. Customize the HTML, CSS, and Javascript used to output your forms, tabs, fields, error messages, and notification emails.
- Added Custom Template Overrides setting to override default form templates with custom templates on a per-form basis.
- Added Custom Template Override support for email notification templates
- Added setting to allow files to be attached to email notifications on a per-form basis (when using Local Asset Sources)
- Template Folder Override form setting defaults to Template Folder Override global setting when a new form is created
- Added support to dynamically set form options in templates using displayForm, displayTab, and displayField tags.
- Added Front-end Field API
- Added support for plugins to register one or more custom front-end fields
- Added form.getField() method which returns a complete FieldModel
- Added front-end support for Assets field and single and multiple file submissions
- Added front-end support for Number field with
numberattribute and decimal validation - Added support for
forattribute and multiple labels with the Checkboxes and RadioButtons fields - Added support for
requiredattribute on input tags - Added support for fields that should not display a value on the front-end using SproutFormsBaseField::isPlainInput()
- Added support for fields that need to use multiple labels using SproutFormsBaseField::hasMultipleLabels()
- Added
craft.sproutForms.addFieldVariables()tag which makes Twig _context, and the option to make additional variables, available to fields. There's a new field type on the way and you won't even see it coming! - Added actionForwardEntry() action to handle form submissions to third-party locations
- Added SproutForms_EntryModel::getPayloadFields() to clean up form fields before forwarding
- Added support for form field validation before forwarding
- Added support for payload error messages to be returned to form just like all other form error messages
- Added
craft.sproutForms.getEntry()tag which gets an active or new SproutForms_EntryModel. - Front-end FieldModel now includes the
requiredattribute - Added integration with upcoming Sprout Reports
- Improved underlying front-end form templates and removed form macro dependencies
- Migrated all supported front-end fields to use the Front-end Field API
- Removed
enableTemplateOverridesandenableFileAttachmentsconfig settings as they are no longer needed - Moved several Form settings from the Overview tab to a new Advanced settings tab.
- Renamed Form settings Overview tab to Settings
- Renamed plugin settings Control Panel tab to Settings
- Developers can now add field type support for front-end forms as easily as they can add support for fields in Craft. Sprout Forms currently supports seven Standard Fields. Additional support can be added for native or custom field types via the Front-end Field API.
- Manage forms that submit your data to third-party endpoints. Enjoy the benefits of the Sprout Forms form builder and integration with Craft relations and validation while sending your data someplace else (for example, to have tighter integration between your website and CRM or to meet specific data security requirements).
- Added the ability to delete entries via bulk actions
- Added the ability to sort entries by the number of fields
- Added the ability to sort entries by the number of total entries
- Added the ability to duplicate a form via Save as new form option
- Improved breadcrumbs and save button styles
- Fixed an issue that occurred while deleting a field from duplicated form
- Fixes logging error in migration
- Updated naming conventions of rules options
- Updated onSaveEntry event to take place after context switching
- Updated Sprout Forms Save Entry event input name to avoid collisions
- Commercial Release
- Adds the ability for a Sprout Email users to trigger notifications when a form entry is saved
- Added conditional validation to Form Notification fields
- Added craft.sproutForms.getForm() tag
- Added
has-errorsclass to field container of form output - Added example US English translation file
- Form Entries now display in the default order of most recent first
- Updated Form Entry page to display fields by tab
- Improved organization of templates and code
- Updated Field Name instructions to indicate usage on front-end as well
- Removed Number of Fields and Number of Entries sorting options which were throwing errors
- Added support for {siteUrl} and all entry and entry content attributes in redirect rule
- Added support for attaching files to notification emails via hidden config setting (sproutForms => enableFileAttachments)
- Added support for tabs in Notification emails
- Notification emails now order fields in the order they appear
- Improved error messages when submitted fields don't validate
- Cleaned up code in tab template for displayForm() tag output
- Template overrides now need to be enabled via a hidden config setting (sproutForms => enableTemplateOverrides)
- Fixed output of date on Form Entries in Control Panel
- Added support for front-end file uploads via custom Asset fields
- Added support for Sprout Forms Entry Element queries
- Fixed rendering issue which cased notifications to fail silently
- Removed initial draft of event integration API
- Fixed issue where Forms could not be organized into multiple groups
- Improved how integrations with older versions of Sprout Email are handled
- Fixed issue where defineSproutEmailEvents() was called even if SproutEmailBaseEvent did not exist
- Added sproutForms.saveEntry event integration for the upcoming release of Sprout Email
- Improved instructions on how to set up notification emails
- Improved the way field values are checked to prevent arrays from being outputted in string context
- Fixed issue where admin notifications were not being sent on Ajax submissions
- Fixed issue where a fatal syntax error in older versions of PHP would break layouts
- Fixed issue where globals would disappear after a failed form submission
- Fixed issue where templates using template_from_string() would not finish rendering after failed submission
- Fixed sorting issue on Form Entries index caused by the Craft 2.3 update
- Forms now support all native Craft fields and custom third-party fields
- Forms now use Craft's Field Layout Editor
- Added Edit Field option to Field Layout Designer
- Build multi-page Forms and single-page Forms with multiple sections
- Forms are searchable
- Forms can be grouped
- Forms can be related to other content via the Sprout Forms Relations Field Type
- Forms can submit to third-party locations
- Form Entry Titles can be customized with any Form field values
- Form Entry Titles can be customized with values from any Form Fields using the Title Format syntax
- Form Entries are searchable (by Title)
- Form Entries are filterable by the Form they belong to
- Form Entries can now be edited in the Control Panel
- Form Entries can be related to other content via the Sprout Form Entry Relations Field Type
- All data from the last Form Entry can be viewed on the Thank You page with the lastEntry() tag
- Form Entries can now be submitted via ajax
- Output your simple forms with one line of code using the displayForm() tag (Supported Fields: Text, Textarea, Number, Dropdown, Checkboxes, Radio Buttons, Multi-select
- Build complex front-end Forms using all field types just as you would with a Craft Entry Form
- Third-party developers can add front-end output support for custom fields
- Distiguish between Basic and Advanced field types when creating Fields
- Override the default Form templates to have 100% control over your dynamic template design
- Override the default email template to have 100% control over your notification email design
- Updated example Forms and various help notes throughout the interface into tool tips
- Forms are now Element Types
- Entries are now Element Types
- Added CSRF Support
- Added support for Command+S to all forms
- Added
editSproutFormsSettingspermission - Added sproutForms.modifyForm hook to form displayForm() template
- Improved layout of Form Edit page
- Form submission can now be faked by third-party plugins
- Added the
SproutFormsFieldTypeClass - Added
onSaveEntryandonBeforeSaveEntryevents
- Notifications can be customized with the values submitted in a Form Entry
- Deprecated
onBeforeSubmitFormEvent
- Fixed Entries page display bug where entries would disappear
- Fixed bug where dropdown and radio fields did not retain state
- Fixed bug if IP address or browser info don't exist when viewing pre-existing entries
- Added support for error handling on pages with multiple forms
- Added Contact Form and Mailing List example forms available on installation
- Added onBeforeSubmitForm() and onBeforeSaveEntry() Events
- Added Twig support to notification field
- Added initial framework for unit testing
- Each submitted entry now captures IP address and browser info
- Added Form settings for submit button type and label
- Added subject and reply-to fields to notifications
- Added support for Sprout Email notifications options to select specific forms
- Added support for displaying form fields without the need for Twig's raw filter
- Various UI adjustments
- Removed Sprout Footer from form entries index page
- Improve email recipient list validation when saving
- A form that fails validation now returns an object that matches the forms handle and falls back to a 'form' object
- A form that fails validation will now return errors as part of the form object formHandle.errors or form.errors. Return values 'error' and 'errors' have been removed.
- A form that fails validation no longer returns an 'entry' object
- Removed error handling using msg() variable
- Deprecated sproutFormsPrePost hook, use onBeforeSubmitForm() Event instead
- Fixed Publish tab code examples to reflect new syntax
- Fixed recipient list validation bug
- Added a "type" variable to each field
- Added a type classname to the parent div when outputting forms programmatically <div class="field checkbox">
- Added an on-submit redirect url form setting on backend that outputs in the form tag
- Added displayField tag: craft.sproutForms.displayField('fieldHandle')
- Added auto-population for 'handle' when title is written in on Form Settings tab
- Added support for Checkboxes, Dropdown, Multi-select, and Radio button fields
- Added field.required variable
- Added support to drag-and-drop fields on field settings page
- Added <span class="required"> * </span> when outputting forms programmatically
- A form that doesn't validate now returns an 'errors' variable
- Renamed PublicController to EntriesController
- Renamed PublicController 'post' function to EntriesController 'saveEntry'
- Renamed field.html to field.input
- You can now retrieve submitted form values using the 'entry' object which is returned when a form doesn't validate
- Renamed field.name to field.label
- Notification emails now recognize line breaks
- Fixed bug on settings page where clicking 'Publish Your Form' would cause a 404
- Fixed bug on notification settings page where clicking 'Submit' would cause a 404
- Remove extraneous output from error messages
- Private Beta