Forms Documentation

Tag Parameters

fentry_id

integer

Form entry entry id. Use this parameter to only return a specific entry

{exp:forms:entries fentry_id="7"}

entry_id

integer

Entry ID of an Channel Entry. Use this parameter to grab the form linked to a specific entry.

{exp:forms:entries entry_id="9"}

fentry_hash

string

Form entry hash Use this parameter to only return a specific entry from its hash.

{exp:forms:entries fentry_hash="h"}

url_title

Same as entry_id=”” but now it with the entry’s url_title.

{exp:forms:entries url_title="title"}

form_name

This parameter can be used to specify a specific form by using it’s form name.

{exp:forms:entries form_name="name of the form"}

member_id

Limit to a specific member. Use CURRENT_USER to specify the current user.

{exp:forms:entries member_id="5"}

prefix

string

This parameter allows you to change the default variable prefix used. This is especially useful when you are nesting tags to avoid variable collisions. Default is "forms".

Default: forms

{exp:forms:entries prefix="forms"}

date_from

Limits form entries returned to those submitted after the specified date.

accepts: An English date format

{exp:forms:entries date_from="2004-06-05 20:00"}

date_to

Limits form entries returned to those submitted prior to the specified date.

accepts: An English date format

{exp:forms:entries date_to="2004-06-05 20:00"}

sort

accepts: desc|asc

{exp:forms:entries sort="desc"}

search:field_url_title

Limits returned entries to those that match the search term in the specified field.

{exp:forms:entries search:store_name="House of Pizza"}

dynamic_parameters

Allows specified parameters to be sent via GET or POST

accepts: All entry specific parameters

{exp:forms:entries dynamic_parameters="date_to|date_from"}

limit

Limits the number of form entries to return.

{exp:forms:entries limit="20"}

offset

Offsets the display by X number of form entries. For example, if you want to show all entries except the three latest ones, you would do this:

{exp:forms:entries offset="3"}

read

Limit form entries based on whether they have been read or not (determination not specific to the current viewer)

accepts: yes|no

{exp:forms:entries read="no"}

Variables

member_id

The member id who submitted the entry.

{forms:member_id}

ip_address

The IP Address of the person.

{forms:ip_address}

date

The date of the submission For date variable info see: http://expressionengine.com/user_guide/templates/date_variable_formatting.html

{forms:date}

country_cc

The country code if available.

{forms:country_cc}

screen_name

The screen name of the user.

{forms:screen_name}

username

The username of the user

{forms:username}

Variable Pairs

field

Saved data for this field.

{forms:field}

field_type

The field type.

{forms:field_type}

field_label

The field label.

{forms:field_label}

field_name

The field short name.

{forms:field_name}

Conditionals

forms:no_form

This tag will conditionally display the code inside the tag if no form was found.

{if forms:no_form}

forms:no_entries

This tag will conditionally display the code inside the tag if there are no submissions for this form.

{if forms:no_entries}

Tag Parameters

entry_id

integer

Entry ID of an Channel Entry. Use this parameter to grab the form linked to a specific entry.

{exp:forms:form entry_id="2"}

url_title

string

Same as entry_id=”” but now it with the entry’s url_title.

{exp:forms:form url_title="url"}

form_name

Specify a specific form by using it’s form name.

{exp:forms:form  form_name="form'sname"}

display_error

Allows you to specify how forms errors will be displayed.

{exp:forms:form display_error=""}

return

string

Allows you to define where the user will be returned after submitting the form. The parameter can be defined in two ways: Use the standard Template_Group/Template syntax to specify where to return the user. For instance, if you want the user to be returned to the “local” Template in the “news” Template Group, you would use: return=”news/local” Use a full URL. For example: return=”http://example.com/return.html“ If this parameter is not defined, they will be returned to the form page.

{exp:forms:form return="”http://example.com/return.html“"}

output_submit

yes/no

Disable the output of the submit button. Default is "yes".

accepts: "y","n"

Default: y

{exp:forms:form output_submit="no"}

queue_js

Delays output of javascript if jQuery is not loaded yet. Used in conjunction with the {exp:forms:output_js} tag.

{exp:forms:form queue_js}

output_js

yes/no

Disable the output of the javascript. Default is "yes".

accepts: "y","n"

{exp:forms:form output_js="no"}

output_css

yes/no

Disable the output of the CSS. Default is "yes".

accepts: "y","n"

Default: y

{exp:forms:form output_css="no"}

prefix

string

This parameter allows you to change the default variable prefix used. This is especially useful when you are nesting tags to avoid variable collisions. Default is "forms".

Default: forms

{exp:forms:form prefix="forms"}

fentry_id

integer

Adding this parameter with a valid form id will allow you to edit the submitted form.

{exp:forms:form fentry_id="5"}

fentry_hash

Adding this parameter with a valid form hash will allow you to edit the submitted form.

{exp:forms:form fentry_hash="valid hash"}

ignore_ip

yes/no

This parameter will ignore the ip address if needed in a cached environment. Normally forms looks for a unique ip per form load. Options are yes/no. Default is no.

accepts: "y","n"

Default: n

{exp:forms:form ignore_ip="yes"}

attr:id

yes/no

This parameter will set the HTML id for the form

Default: new_submission

{exp:forms:form attr:id="my_id"}

attr:class

yes/no

This parameter will set the HTML class for the form

Default: form_url_title

{exp:forms:form attr:class="my_class"}

attr:onsubmit

This parameter will set the HTML on submit for the form

{exp:forms:form attr:onsubmit="my_onsub"}

style_page

path or template name

This parameter will allow for a file to be used as the styling to overwrite the defaulted style. Output Css from above must be allowed. For example: style_page="forms-style" will grab a css template named forms-style in the same template group as this tagged template

{exp:forms:form style_page="forms-style"}

Variables

form_id

The internal Form ID.

{forms:form_id}

label

The form label.

{forms:label}

short_name

The form short name.

{forms:short_name}

entry_id

The entry_id linked to this form (if any).

{forms:entry_id}

channel_id

The channel_id of the entry linked to this form (if any).

{forms:channel_id}

ee_field_id

The field_id of the entry linked to this form (if any).

{forms:ee_field_id}

member_id

The member_id of the member who created this form.

{forms:member_id}

date_created

Creation date of this form.

{forms:date_created}

date_last_entry

The date of the last entry submission.

{forms:date_last_entry}

total_entries

The total amount of submissions.

{forms:total_entries}

forms:current_page

integer

The current page number.

{current_page}

total_pages

integer

The total amount of pages this form has.

{forms:total_pages}

paged

A simple variable that outputs “yes” if the current form has multiple pages.

{forms:paged}

total_form_errors

The total amount of “Global” form submission errors.

{forms:total_form_errors}

total_field_errors

The total amount of “Field” related form submission errors.

{forms:total_field_errors}

Variable Pairs

field

{forms:fields} Variable Pair

Renders the field.

{forms:field}

field_type

{forms:fields} Variable Pair

The field type.

{forms:field_type}

forms:error

{forms:form_errors} Variable Pair

The error message.

{forms:error}

forms:error_count

{forms:form_errors} Variable Pair

The error count in the current loop.

{forms:error_count}

forms:error_type

{forms:form_errors} Variable Pair

The error type.

{forms:error_type}

Conditionals

forms:no_form

This tag will conditionally display the code inside the tag if no form was found.

{if forms:no_form}

forms:closed

This tag will conditionally display the code inside the tag if the form is closed.

{if forms:closed}

Email Notification Override

notify_admin_from_name

From Name

{}

notify_admin_from_email

From Email

{}

notify_admin_cc

Email CC (separate multiple by comma)

{}

notify_admin_subject

Email Subject

{}

notify_admin_bcc

Email BCC (separate multiple by comma)

{}

notify_admin_replyto_name

Reply-To Name

{}

notify_admin_replyto_email

Reply-To Email

{}

notify_admin_replyto_author

Set to “yes” to use submission author info

{}

notify_user_from_name

From Name

{}

notify_user_from_email

From Email

{}

notify_user_cc

Email CC (separate multiple by comma)

{}

notify_user_subject

Email Subject

{}

notify_user_bcc

Email BCC (separate multiple by comma)

{}

notify_user_replyto_name

Reply-To Name

{}

notify_user_replyto_email

Reply-To Email

{}