Skip to content Skip to footer navigation
You are reading the Statamic 6 Alpha docs. πŸ‘€

Relative Modifier

Returns a date difference in a nice, human readable, string format. This modifier will add a phrase after the difference value relative to the current date and the passed in date.

You can turn off the extra words "ago", "until", and so on by passing true as a parameter

The string will be localized into your current site locale.

past_date: October 1 2020
future_date: October 1 2024
{{ past_date | relative }}
{{ past_date | relative(true) }}
{{ future_date | relative }}
{{ future_date | relative(true) }}
{{ Statamic::modify($past_date)->relative() }}
{{ Statamic::modify($past_date)->relative(true) }}
{{ Statamic::modify($future_date)->relative() }}
{{ Statamic::modify($future_date)->relative(true) }}
2 years ago
2 years
1 year from now
1 year
Warning!

By default, when using a modifier on a date variable, it will be operating on the UTC date rather than the localized date.

Please refer to our Timezones guide for more information.

A troll pointing a teaching stick