Skip to documentation content

Form

On this page

    The Form entity and methods for working with forms and form submissions.

    {{ form }}

    Properties
    Name Type Description
    object_type string Will always be form
    is_valid boolean True if this references a published form
    guid string The unique identifier for this form
    value string Synonym for guid
    name {{ text }} The name of the form
    title {{ text }} The title of the form
    linked_title string A link to the form if it has a URL, or the escaped title if not
    redirect_url {{ url }} URL to navigate to after a successful form submission
    template_override_guid string The unique identifier of the template that should be used to output this form
    template_override {{ template }} The template that should be used to output this form
    form_unique_identifier string 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)
    form_start string A helper property to assist in creating the form markup. This property includes the form tag with the form_unique_identifier
    form_end string 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
    javascript string 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
    javascript_field_config string 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
    javascript_form_config string 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
    form_submit_target string 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
    fields list 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
    has_url boolean True if the form has a URL
    include_in_search boolean Whether or not this form should be returned in on-site search results
    domain_name {{ text }} The domain name used by the URL for this form
    url {{ text }} The portion of the URL for this form following the domain name
    full_url string The full URL for this form including the scheme, domain name, and path
    visited boolean 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
    template_guid string The unique identifier for the template that would be used to respond to this URL
    template {{ template }} The template that would be used to respond to this URL
    canonical_url {{ url }} The canonical URL if this is not the original source of content for this URL
    browser_title {{ text }} The browser title to use for this URL
    meta_description {{ textarea }} The meta description for this URL
    meta_robots {{ text }} The meta robots for this URL
    keywords {{ textarea }} The SEO keywords for this URL
    search_entity_guid string The unique identifier for the entity that search results should be directed to (if this form does not have a URL)
    search_entity {{ entity }} The entity that search results should be directed to (if this form does not have a URL)
    folder_guid string The unique identifier for the folder that contains this form.
    folder {{ folder }} The folder that contains this form.
    field_id string The identifier for this field
    label string The label for this field
    output string The default output that the form produces when output directly to the template. The default output may change at any time. Template developers should avoid using this and should handle the output of forms themselves
    data {{ data }} Object containing the custom fields on this form
    * string Specific custom fields may be accessed using {{ entity.fieldid }} or {{form['field-id']}}

    {{ forms }}

    Contains multiple forms.

    Properties
    Name Type Description
    object_type string Will always be forms
    is_valid boolean True if this contains at least one published form
    output string 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
    prepended list List containing any prepended forms.
    fetched list List containing all of the forms that were fetched from the database (as opposed to prepended or appended).
    appended list List containing any appended forms.
    appended_unique list List containing any appended forms excluding any forms that are in either the list of prepended or fetched forms.
    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.
    size integer The total number of forms in the items list, including prepended, fetched, and appended lists, and respecting the unique and max_size properties.
    max_size integer 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.
    unique boolean When true, the items list will not contain any duplicates. Only the first instance of each form will be included.
    limit integer 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.
    start integer The 1-based index of the first item in the list of fetched forms.
    page integer 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.
    total_count integer The 1-based index of the first item in the list of fetched forms
    total_pages integer 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.

    {% form %}

    {% form output_to_template? [[var, set, or assign]? variable]? output_to_template? = value %}
    Parameters
    output_to_template optionalflag
    If included the {% form %} will be output directly to the template.
    var, set, or assign optionalkeyword
    Optional. Specify either "var", "set" or "assign" to change which scope this {% form %} is stored on. "var" is the default behavior.
    variable_name optionalvariable
    Specify a variable name in order to save this form to a variable. If not specified, it will be output to the template instead.
    value requiredexpression
    Should evaluate to an object of type form, or the name or guid of one. May use liquid filters.

    Fetches a single {{ form }}.

    {% forms %}

    {% forms output_to_template? [[var, set, or assign]? variable]? output_to_template? = arguments %}
    Parameters
    output_to_template optionalflag
    If included the {% forms %} will be output directly to the template.
    var, set, or assign optionalkeyword
    Optional. Specify either "var", "set" or "assign" to change which scope this {% forms %} is stored on. "var" is the default behavior.
    variable optionalvariable
    arguments requiredcollection
    Key:value pairs. May use the variable arguments syntax.

    Options

    prepend optionallist
    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.
    append optionallist
    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.
    exclude optionallist
    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_prepended optionalboolean
    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_appended optionalboolean
    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.
    unique optionalboolean
    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_size optionalinteger
    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".
    filter optionalvalue
    Only include forms that match the given string filter
    folder optionalvalue
    May include multiple folders. Only include forms with one of the given folders
    date_created_start optionalvalue
    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_end optionalvalue
    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_url optionalboolean
    If true, only return forms that have a URL. If false, only return forms that do NOT have a URL.
    template optionalobject
    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.
    include_in_search optionalboolean
    True or false to only return forms whose include_in_search property matches the provided value.
    domain_name optionalobject
    Only return forms from the given domain.
    start optionalinteger
    Set the 1-based index of the first form to fetch.
    page optionalinteger
    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.
    limit optionalinteger
    The maximum number of forms to fetch. Defaults to 10. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.
    sort_by optionalstring
    Specify which property to sort the results by. Has no effect on prepended or appended forms. 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. When sorting by relevance sort_direction is ignored.
    • 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_direction optionalstring
    asc or desc.
    cache_random optionalboolean
    True to allow the results to be cached when sort_by is "random".

    Fetches a list of {{ forms }}.