A field containing a user-selected date
| 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.
Should be used to display a date field inside a form.
| 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 |
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
You can use the date filter either to create a date object or to format a date as a string.
Many ways to use the date filter
Copycreate a date object
Defaults to the current date
format a date as a string
Entity Date Opened with Date Filter
CopyAssign date add month and fetch calendar_entries
CopyVar date assignment and date math
CopyFormat dates using standard or custom .NET date formats.
Format Dates
CopyTime advanced
CopyTo timezone filter
CopyReturns 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
You can use the date filter either to create a date object or to format a date as a string.
Many ways to use the date filter
Copycreate a date object
Defaults to the current date
format a date as a string
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
Format time diffs using standard or custom.NET TimeSpan formats.
Format Time Diffs
CopyTime diff
CopyReturns 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
Use the timezone filter to output the timezone used by a date object. The output may either be the full timezone identifier or the shortened timezone abbreviation.
Using the timezone filter
CopyConverts a date to the specified timezone.
to_timezone: String timezone
Use the to_timezone filter to convert a date to a specific timezone.
Using the to_timezone filter
CopyReturn a date object operand minutes in the future from the input date.
add_minutes: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand years in the future from the input date.
add_years: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand months in the future from the input date.
add_months: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand weeks in the future from the input date.
add_weeks: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand hours in the future from the input date.
add_hours: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand days in the future from the input date.
add_days: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand seconds in the future from the input date.
add_seconds: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
A field containing a user-selected date
| 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 and time |
| 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.
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
You can use the date filter either to create a date object or to format a date as a string.
Many ways to use the date filter
Copycreate a date object
Defaults to the current date
format a date as a string
Entity Date Opened with Date Filter
CopyAssign date add month and fetch calendar_entries
CopyVar date assignment and date math
CopyFormat dates using standard or custom .NET date formats.
Format Dates
CopyTime advanced
CopyTo timezone filter
CopyReturns 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
You can use the date filter either to create a date object or to format a date as a string.
Many ways to use the date filter
Copycreate a date object
Defaults to the current date
format a date as a string
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
Format time diffs using standard or custom.NET TimeSpan formats.
Format Time Diffs
CopyTime diff
CopyReturns 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
Use the timezone filter to output the timezone used by a date object. The output may either be the full timezone identifier or the shortened timezone abbreviation.
Using the timezone filter
CopyConverts a date to the specified timezone.
to_timezone: String timezone
Use the to_timezone filter to convert a date to a specific timezone.
Using the to_timezone filter
CopyReturn a date object operand minutes in the future from the input date.
add_minutes: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand years in the future from the input date.
add_years: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand months in the future from the input date.
add_months: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand weeks in the future from the input date.
add_weeks: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand hours in the future from the input date.
add_hours: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand days in the future from the input date.
add_days: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Return a date object operand seconds in the future from the input date.
add_seconds: Integer operand
Use the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
Sets the default timezone to use when rendering dates and times on the page that do not already have a separate timezone configured.
Some dates and times do not use the default timezone and will not be affected by this method.
Set Timezone by String
CopySet Timezone with string manipulation
CopySet Timezone with string manipulation
CopyYou can use the date filter either to create a date object or to format a date as a string.
Many ways to use the date filter
Copycreate a date object
Defaults to the current date
format a date as a string
Set Timezone by String
CopyContains information about the difference between two dates.
| Name | Type | Description |
| is_valid | Boolean | Will always be true |
| days | Integer | The number of days between the two dates |
| hours | Integer | The hours component of the difference between the two dates (eg: if the dates are 25 hours apart this will be 1 since they are 1 day and 1 hour apart) |
| minutes | Integer | The minutes component of the difference between the two dates (eg: if the dates are 90 minutes apart this will be 30 since they are 1 hour and 30 minutes apart) |
| seconds | Integer | The seconds component of the difference between the two dates (eg: if the dates are 70 seconds apart this will be 10 since they are 1 minute and 10 seconds apart) |
| total_days | Number | The total difference between the two dates expressed as whole and fractional days (eg: 25 hours apart would be 1.042 days) |
| total_hours | Number | The total difference between the two dates expressed as whole and fractional hours (eg: 1 day and 90 minutes apart would be 25.5 hours) |
| total_minutes | Number | The total difference between the two dates expressed as whole and fractional minutes (eg: 90 minutes, and 10 seconds apart would be 90.167 minutes) |
| total_seconds | Number | The total difference between the two dates expressed as whole and fractional seconds (eg: 122 seconds and 10 milliseconds apart would be 122.1 seconds) |
| output | String | The time diff represented as a string using the standard "constant" format ([-][d.]hh:mm:ss[.fffffff] where all portions of the format in brackets are only included when needed) |
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
Format time diffs using standard or custom.NET TimeSpan formats.
Format Time Diffs
CopyTime diff
CopyTime diff
CopyFormat time diffs using standard or custom.NET TimeSpan formats.
Format Time Diffs
CopyRepresents a specific instant in a specific timezone.
| Name | Type | Description |
| is_valid | Boolean | Will always be true |
| is_future | Boolean | Will be true if the time is in the future and false if the time is in the past. Prevents the page from being fast-cached past when this would change from true to false |
| year | Integer | The calendar year |
| month | Number | The calendar month (1-12) |
| day | Integer | The calendar day of the month (1-31) |
| day_of_year | Integer | The day of the year (1-366) |
| day_of_week | Integer | The day of the week (Monday = 1, Sunday = 7) |
| hour | Integer | The hour of the day (0-23) |
| minute | Integer | The minute of the hour (0-59) |
| second | Integer | The second of the minute (0-59) |
| offset | time_diff | The utc offset of the timezone at this instant expressed as a time_diff (ranging from -14 to +14 hours) |
| timezone | String | The full timezone identifier |
| timezone_short | String | The shortened timezone identifier, if applicable, for the given timezone at this instant (may vary depending on time of year, and for some timezones may be the same as the full timezone identifier) |
| output | String | The instant output using the ISO 8601 standard (yyyy-MM-ddTHH:mm:ss.fffffff) |
Time advanced
CopySet Timezone with string manipulation
CopySet Timezone by String
Copy| Name | Type | Description |
| is_valid | Boolean | True if the value is a valid timezone string |
| value | String | timezone string |
| 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 | timezone string. May include additional markup in the editor preview to make it easier to edit content |
Stores the timezone that should be used when displaying a date and/or time.
Sets the default timezone to use when rendering dates and times on the page that do not already have a separate timezone configured.
Some dates and times do not use the default timezone and will not be affected by this method.
Set Timezone by String
CopySet Timezone with string manipulation
CopyConverts a date to the specified timezone.
to_timezone: String timezone
Use the to_timezone filter to convert a date to a specific timezone.
Using the to_timezone filter
CopyReturns 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
Use the timezone filter to output the timezone used by a date object. The output may either be the full timezone identifier or the shortened timezone abbreviation.
Using the timezone filter
CopySet Timezone with string manipulation
CopyTo timezone filter
CopyTo timezone filter with formatting
CopyUse the to_timezone filter to convert a date to a specific timezone.
Using the to_timezone filter
CopyUse the timezone filter to output the timezone used by a date object. The output may either be the full timezone identifier or the shortened timezone abbreviation.
Using the timezone filter
CopySet Timezone by String
CopyUse the add_seconds, add_minutes, add_hours, add_days, add_weeks, add_months, and add_years filters to manipulate dates.
Use math to manipulate dates
Copyadd_seconds
add_minutes
add_hours
add_days
add_weeks
add_months
add_years
You can use the date filter either to create a date object or to format a date as a string.
Many ways to use the date filter
Copycreate a date object
Defaults to the current date
format a date as a string