Invisible Field

The Invisible Field allows you to define the value of a field on your form ahead of time without displaying that field to the user. This can be useful to help prepare information that will need to be associated with a form but doesn't necessarily need to be seen or filled out by the user.

The Invisible Field never shows the value of the field to the user on the front-end, not even in the code, so you can safely use this field for analytics, email addresses, or other data that you may not want to expose to the user but that you want associated with their form submission.

# Settings

# Invisible Field Value

This setting let's you predefine the value you want to see in your Invisible Field. It can parse Twig and any values provided via the addFieldVariables template tag. See the Field Variables section below for more info.

# Allow edits

Enable this setting if you wish to allow users in the Control Panel to edit this Invisible Field value. By default, the field will display the value but not allow any edits.

# Field Variables

When using the default Form Templates, the Invisible Field has access to several common variables that are also available as Craft Global Variables. The default variables include:

  • craft
  • currentSite
  • currentUser
  • now
  • siteName
  • siteUrl
  • systemName

These default values can be customized when using Template Overrides and additional variables can be made available using the addFieldVariables tag. To add additional variables, pass those variables to the addFieldVariables tag in your templates before the displayForm tag.

{% do craft.sproutForms.addFieldVariables({
    'entry': entry,
    'category': category,
    'hiddenEmail': '[email protected]'
}) %}

{{ craft.sproutForms.displayForm('application') }}

The Invisible Field Value setting is processed like a Twig Template and you can target the available variables are all made available to the field using the object variable. The variables can be accessed using standard Twig syntax or shorthand object syntax:

{{ }}
{{ object.entry.title }}
{{ object.entry.customField }}
{{ object.entry.customField.first().id }}
{{ object.hiddenEmail }}

And shorthand syntax:

Last Updated: 11/23/2023, 10:32:53 PM