A helper property containing a unique ID for this instance of this form. Every time this form is output - either from this instance or from multiple instances - it should have a different ID. Specifically, every time the form_end property is accessed the unique ID will be reset to a new value (thereby preventing conflicting javascript code and element identifiers)
A helper property to assist in creating the form markup. This property includes the end form tag as well as some javascript that will be used to assist in processing conditional fields, form validation, and form submissions
A helper property to assist in creating the form markup. This property includes all of the javascript that will be output from the form_end property. USE WITH CAUTION
A helper property to assist in creating the form markup. This property includes the field configurations for the javascript that will be output from the javascript property. USE WITH CAUTION
A helper property to assist in creating the form markup. This property includes the form configuration for the javascript that will be output from the javascript property. USE WITH CAUTION
A helper property in case you decide to build and submit the form without using the form_start and form-end properties. This property contains the URL that the form must be submitted to in order to be recorded by Marketpath CMS as a form submission
A list containing all of the form fields that are direct children of the current form.Note that any fields (or groups) that are part of a parent group will NOT be included in this list - they will be included as children of their parent group
Whether or not the user has visited this URL previously in their current session. Note that this will always be false if the user has not allowed session permission (see the Permissions and Personalization documentation). Using this property prevents the page from being fast-cached
The default output that the form produces when output directly to the template. If the form has a template override, that template is used to output the form; otherwise it falls back to built-in markup, which may change at any time. Template developers should avoid relying on the built-in markup and should handle the output of forms themselves
Specific custom fields may be accessed using {{ entity.fieldid }} or {{form['field-id']}}
ExampleLoad one form and list each form_field label{% form %} loads a single form by name or GUID; fields is the list of form_field controls on that form.
Liquid
{%- form var contact = "Contact Us" -%}
{%- if contact.is_valid -%}
<h2>{{ contact.title }}</h2>
<ul>
{%- for field in contact.fields -%}
<li>{{ field.label }} ({{ field.object_type }})</li>
{%- endfor -%}
</ul>
{%- endif -%}
ExampleFetch forms by filter string and list their titles{% forms %} returns a forms list; use filter (and shared list options) to narrow results.
Liquid
{%- forms var surveys = filter:"Survey" limit:25 sort_by:"title" -%}
<ul>
{%- for survey in surveys -%}
<li>{{ survey.linked_title }}</li>
{%- endfor -%}
</ul>
The default output that the forms will produce when it is output directly to the template - using the "output_in_list" property of each form in the items list
List containing all of the combined forms from the prepended, fetched, and appended lists. If unique is true, this list will not contain any duplicates. If max_size is set, this list will not contain more than the number of forms specified.
If set, this is the maximum number of items that will be returned in the items list and the maximum number of items that will be included when this forms object is enumerated as a list. When not set, this value will be 0.
The maximum number of items that were allowed to be in the list of fetched forms. May be 0 in some cases (such as when when there are no fetched forms.
The 1-based index of the paginated results returned in the list of fetched forms, which is calculated from the start and limit parameters. Useful for paginated results.
If any items were fetched from the database, total_pages will contain the number of paginated result pages in the database for the provided arguments. This may also be calculated using the total_count and limit properties.
ExampleFetch forms by filter string and list their titles{% forms %} returns a forms list; use filter (and shared list options) to narrow results.
Liquid
{%- forms var surveys = filter:"Survey" limit:25 sort_by:"title" -%}
<ul>
{%- for survey in surveys -%}
<li>{{ survey.linked_title }}</li>
{%- endfor -%}
</ul>
{% form %}
{% form output_to_template? [[var, set, or assign]? variable_name]? output_to_template? = value %}Parameters
output_to_templateoptionalflag
Include this flag to write the form's output into the page at this point. What that output is differs by type, and for most types it is a built-in default that may change at any time, so see the output property of the form object before relying on it. The flag may come before or after the variable name. When the call names no variable, the output is written whether or not the flag is present, which makes {% form = value %} the smallest valid use of this method. When the call names a variable, the flag saves the form to the variable and writes its output as well.
var, set, or assignoptionalkeyword
Chooses the scope that holds the variable. var, the default, stores it in the current scope. set and assign can store it in outer scopes; Variable Scopes compares the three and when each fits.
variable_nameoptionalvariable
The variable that receives the form. It may also be written as a reference, &name, which reads the variable's name from another variable (see Methods Overview). Leave it out to write the form to the template instead.
valuerequiredexpression
Required; without a value the method call is not valid. Identifies which form to fetch. It can evaluate to the form itself, to its GUID, or to other text that identifies it, which for most types is its name; a type identified some other way, or only by GUID, says so in its summary. Names are matched without regard to case, but accented letters must match. A GUID identifies exactly one record, whereas when several records share a name, which of them is returned is not specified, so giving the records you fetch by name unique names avoids the question. A name reads better in a template and a GUID is exact; neither suits every site. When nothing matches, no error is raised: the variable holds an invalid form, whose is_valid is false, so check is_valid before using it. When the expression itself has no value, for example an undefined variable, the method does nothing and the variable keeps any earlier value. May use liquid filters.
ExampleLoad one form and list each form_field label{% form %} loads a single form by name or GUID; fields is the list of form_field controls on that form.
Liquid
{%- form var contact = "Contact Us" -%}
{%- if contact.is_valid -%}
<h2>{{ contact.title }}</h2>
<ul>
{%- for field in contact.fields -%}
<li>{{ field.label }} ({{ field.object_type }})</li>
{%- endfor -%}
</ul>
{%- endif -%}
{% forms %}
{% forms output_to_template? [[var, set, or assign]? variable_name]? output_to_template? = arguments %}Parameters
output_to_templateoptionalflag
Include this flag to write the forms list's output into the page here. That output is a built-in default for most types and may change at any time, so see the output property of the forms object before relying on it. The flag may come before or after the variable name. With no variable named, the output is written whether or not the flag is present; with one, the flag saves the list and writes its output too.
var, set, or assignoptionalkeyword
Chooses the scope that holds the variable. var, the default, stores it in the current scope. set and assign can store it in outer scopes; Variable Scopes compares the three and when each fits.
variable_nameoptionalvariable
The variable that receives the forms list. It may also be written as a reference, &name, which reads the variable's name from another variable (see Methods Overview). Leave it out to write the list to the template instead.
argumentsrequiredcollection
Key:value pairs. May use the variable arguments syntax. Written after a required =. The name:value pairs choose which forms to fetch and how to narrow, order and page them. Nothing is fetched unless the call gives an argument other than prepend, append, unique, exclude_prepended, exclude_appended, max_size and cache_random; without one, the list holds only the prepended and appended forms.
Options
prependoptionallist
May be a single form, a list of forms, or the name or guid of one form, to be included at the beginning of the forms list.
appendoptionallist
May be a single form, a list of forms, or the name or guid of one form, to be included at the end of the forms list.
excludeoptionallist
May be a single form, a list of forms, or the name or guid of one form that should NOT be included in the fetched results. Has no effect on prepended or appended forms.
exclude_prependedoptionalboolean
True to specifically exclude all prepended forms from the fetched results. If "unique:true" is specified this is the default behavior, although you may also specify "exclude_prepended:false" to allow any prepended items to be fetched along with other results anyway.
exclude_appendedoptionalboolean
True to specifically exclude all appended forms from the fetched results. This is false by default - even if "unique:true" is specified - so that results are returned in the proper order.
uniqueoptionalboolean
True to remove duplicates from each of the resulting lists (prepended, fetched, appended, and items), although there may be duplicates between the prepended, fetched, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first, then fetched items, then appended items.
max_sizeoptionalinteger
The maximum number of items to be included in the "items" list. If there are any prepended or appended items, this will automatically lower the "limit" to only fetch as many forms as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting forms. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
filteroptionalvalue
Only include forms that match the given string filter
folderoptionalvalue
May include multiple folders. Only include forms with one of the given folders
date_created_startoptionalvalue
Only include forms with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the form was first published.
date_created_endoptionalvalue
Only include forms with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the form was first published.
has_urloptionalboolean
If true, only return forms that have a URL. If false, only return forms that do NOT have a URL.
templateoptionalobject
Only return forms with one of these templates. May be a single template, a list of templates, or the name or guid of a template to filter the results by. A template name is its path from the root, with or without the leading /; unlike {% template %}, a list method does not accept a relative path.
include_in_searchoptionalboolean
True or false to only return forms whose include_in_search property matches the provided value.
domain_nameoptionalobject
Only return forms from the given domain.
startoptionalinteger
Set the 1-based index of the first form to fetch.
pageoptionalinteger
Used to automatically calculate the first form to fetch based on both the "limit" and the 1-based "page" value. Defaults to 1, but is ignored if "start" is set.
limitoptionalinteger
The maximum number of forms to fetch. Defaults to 10; a value that is not a number also gives 10. The largest limit is 1000, and a limit of 0 or less, or above 1000, returns up to 1000 forms. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.
sort_byoptionalstring
Specify which property to sort the results by. Has no effect on prepended or appended forms. An unrecognized value is ignored without an error and the default order is used. Some methods accept more values than the built-ins listed here; see each method. By default, results will be sorted by relevance if there is a filter string and date_created desc (newest first) if not. Options include:
relevance: only applies when there is a filter string. sort_direction applies: descending, the default, puts the best match first.
date_created: the date each form was first published. Unpublishing and republishing one resets date_created to the current date.
random: results will be returned in a random order, which prevents the page from being fast-cached. Setting cache_random:true overrides this behavior and allows the page to be fast-cached anyway.
name
title
url
browser_title
sort_directionoptionalstring
asc or desc. Defaults to desc; any value other than asc sorts descending.
cache_randomoptionalboolean
True to allow the results to be cached when sort_by is "random".