Date

Date

{{ date }}

A field containing a user-selected date

Properties of {{ date }} objects
Name Type Description
is_valid Boolean True if the value is not empty
value String Unformatted date string (in UTC)
date time An object containing more detailed information about the selected date
default_value String The default value for this field if no value is specified
field_id String The identifier for this field
label String The label for this field
output String The value formatted using the "Short date pattern" (MM/dd/yyyy). May include additional markup in the editor preview to make it easier to edit content

Field used to store a date. All dates are stored in UTC time.

Related

object

May be any object, including simple, complex and list objects. In some cases may even include symbols and null.

{{ form }}

{{ select }}

string

Can be any text, from the empty string ("") to the full HTML output of the template. When used alone in a conditional, all strings evaluates as true - even if they are empty or a value such as "0" or "false".

{{ date_field }}

Should be used to display a date field inside a form.

{{ time }}

Represents a specific instant in a specific timezone.

{{ date_field }}

Should be used to display a date field inside a form.

Properties of {{ date_field }} objects
Name Type Description
is_valid Boolean Will always be true
type String Will always be "date"
default_value time Optional. The default value to use for this date field when the form is displayed. Will be null if there is no default value
map_to_attribute String If the user is signed into a profile when they submit this form and map_to_attribute is set, the profile attribute specified in map_to_attribute will be set to the value of this field. This should also be used to override the default value if the user is signed into a profile and the specified attribute has already been set
required Boolean Will be true if the user is required to enter a date before submitting the form
required_message String The message to display when the user attempts to submit the form without entering a date
validators validators The list of validators that should be used to validate this date field, if applicable
element_id String A helper property containing a unique ID for this field on this instance of this form. This value should be different every time the form is output
subtext text Help or hint text to display together with the field
condition condition The condition that should be used to show and hide this form field
classname String CSS class name(s) to be applied to the field
field_id String The identifier for this field
label String The label for this field
output String Default HTML markup for this date field, which makes a number of assumptions about other elements on the page that may or may not be included. Developers should avoid using the default output in order to guarantee that forms work as expected, including styling, validation, conditionals, and more. May include additional markup in the editor preview to make it easier to edit content

Related

{{ form_field }}

{{ label_field }}

Should be used to display a text label inside a form.

{{ form }}

{{ submit_field }}

Should be used to display a submit button inside a form.

{{ checkboxlist_field }}

Should be used to display a list of checkboxes inside a form.

{{ date }}

A field containing a user-selected date

{{ textarea_field }}

Should be used to display a textarea field inside a form.

{{ text }}

{{ hidden_field }}

Should be used to output a hidden field inside a form, which by definition is not displayed to or directly editable by users.

string

Can be any text, from the empty string ("") to the full HTML output of the template. When used alone in a conditional, all strings evaluates as true - even if they are empty or a value such as "0" or "false".

{{ select_field }}

Should be used to display a select list inside a form.

{{ button_field }}

Should be used to display a custom button inside a form.

{{ captcha_field }}

Should be used to display a captcha inside a form.

null

Represents empty space or a non-existant object. Like how you would describe a chair that is missing from the table, or the food on an empty platter.

{{ profile }}

{{ condition }}

Represents the condition that should be used to show and hide form fields.

{{ file_field }}

Should be used to display a file upload field inside a form.

{{ time }}

Represents a specific instant in a specific timezone.

Examples

Set a date range (e.g. from now to one month ahead) and fetch calendar_entries into the template.

Fetch calendar_entries for the next month using assign and date filters

Copy
{%- assign minDate = "now" | midnight -%}
{%- assign maxDate = minDate | add_months: 1 -%}
{%- calendar_entries output_to_template start_date:minDate end_date:maxDate limit:30 sort_by:"start_date" sort_direction:"asc" -%}

date filter

Returns the input as a date. If format is specified, converts the date to a string before returning it using the given format. The format must be a valid standard or custom .NET date format.

date: String format

If the input is already a date object, it will be used as-is - either to be formatted or returned without alteration. If the input is a number, it will be interpreted as a unix timestamp - that is the seconds since the Unix Epoch (midnight on January 1, 1970 UTC). If the input is not already a date and is not a number, it will attempt to parse it as the string representation of a date. If the input cannot be converted to a date using any of the previous methods, it will use the current date and time - which will prevent the page from being fast-cached. In all cases where the date filter creates a new date object, it uses the current timezone - which defaults to the site's timezone but may be set explicitly using the {% set_timezone %} method.

Examples

Set a date range (e.g. from now to one month ahead) and fetch calendar_entries into the template.

Fetch calendar_entries for the next month using assign and date filters

Copy
{%- assign minDate = "now" | midnight -%}
{%- assign maxDate = minDate | add_months: 1 -%}
{%- calendar_entries output_to_template start_date:minDate end_date:maxDate limit:30 sort_by:"start_date" sort_direction:"asc" -%}

Related

{{ date }}

A field containing a user-selected date

{{ date_field }}

Should be used to display a date field inside a form.

time_diff filter

If format is unspecified, returns a time_diff object describing the difference between the current date and the other date. If format is specified, converts the time difference to a string before returning it using the given format. If supplied, the format must be a valid standard or custom .NET TimeSpan format.

time_diff: time otherString format

Related

{{ time_diff }}

Contains information about the difference between two dates.

{{ time }}

Represents a specific instant in a specific timezone.

timezone filter

Returns the timezone that the date is in. If full is true or if an abbreviated timezone name is not available, returns the full timezone identifier (eg: "Europe/Rome"). If full is false (default) or not specified and an abbreviated timezone name is available returns the abbreviated timezone name (eg: "PST" or "PDT").

timezone: Boolean full

Related

{{ timezone }}

to_timezone filter

Converts a date to the specified timezone.

to_timezone: String timezone

Related

{{ timezone }}

{% set_timezone %}

Sets the default timezone to use when rendering dates and times on the page that do not already have a separate timezone configured.

add_minutes filter

Return a date object operand minutes in the future from the input date.

add_minutes: Integer operand

If operand is negative, return a date that many minutes in the past from the input date.

Related

{% add_stylesheet %}

Add a stylesheet asset to the head of the current page via a <link> tag

{% add_javascript %}

Add a script asset to the current page via a <script> tag

{% add_javascript inline %}

Outputs javascript code in an inline script

{% add_stylesheet inline %}

Outputs an inline stylesheet in a <style> tag.

add_years filter

Return a date object operand years in the future from the input date.

add_years: Integer operand

If operand is negative, return a date that many years in the past from the input date.

Related

{% add_stylesheet %}

Add a stylesheet asset to the head of the current page via a <link> tag

{% add_javascript %}

Add a script asset to the current page via a <script> tag

{% add_javascript inline %}

Outputs javascript code in an inline script

{% add_stylesheet inline %}

Outputs an inline stylesheet in a <style> tag.

add_months filter

Return a date object operand months in the future from the input date.

add_months: Integer operand

If operand is negative, return a date that many months in the past from the input date.

Related

{% add_stylesheet %}

Add a stylesheet asset to the head of the current page via a <link> tag

{% add_javascript %}

Add a script asset to the current page via a <script> tag

{% add_javascript inline %}

Outputs javascript code in an inline script

{% add_stylesheet inline %}

Outputs an inline stylesheet in a <style> tag.

add_weeks filter

Return a date object operand weeks in the future from the input date.

add_weeks: Integer operand

If operand is negative, return a date that many weeks in the past from the input date.

Related

{% add_stylesheet %}

Add a stylesheet asset to the head of the current page via a <link> tag

{% add_javascript %}

Add a script asset to the current page via a <script> tag

{% add_javascript inline %}

Outputs javascript code in an inline script

{% add_stylesheet inline %}

Outputs an inline stylesheet in a <style> tag.

add_hours filter

Return a date object operand hours in the future from the input date.

add_hours: Integer operand

If operand is negative, return a date that many hours in the past from the input date.

Related

{% add_stylesheet %}

Add a stylesheet asset to the head of the current page via a <link> tag

{% add_javascript %}

Add a script asset to the current page via a <script> tag

{% add_javascript inline %}

Outputs javascript code in an inline script

{% add_stylesheet inline %}

Outputs an inline stylesheet in a <style> tag.

add_days filter

Return a date object operand days in the future from the input date.

add_days: Integer operand

If operand is negative, return a date that many days in the past from the input date.

Related

{% add_stylesheet %}

Add a stylesheet asset to the head of the current page via a <link> tag

{% add_javascript %}

Add a script asset to the current page via a <script> tag

{% add_javascript inline %}

Outputs javascript code in an inline script

{% add_stylesheet inline %}

Outputs an inline stylesheet in a <style> tag.

add_seconds filter

Return a date object operand seconds in the future from the input date.

add_seconds: Integer operand

If operand is negative, return a date that many seconds in the past from the input date.

Related

{% add_stylesheet %}

Add a stylesheet asset to the head of the current page via a <link> tag

{% add_javascript %}

Add a script asset to the current page via a <script> tag

{% add_javascript inline %}

Outputs javascript code in an inline script

{% add_stylesheet inline %}

Outputs an inline stylesheet in a <style> tag.

Conditions

is_date

Returns true if the subject is a date object. If the operand is true,will check if the object is a string that can be safely converted to true or false (eg: {% if subject is_date true %}).

Related:

{{ date }}

A field containing a user-selected date

{{ date_field }}

Should be used to display a date field inside a form.