$datetime->relativeTimeStr() method

Given a unix timestamp (or date string), returns a formatted string indicating the time relative to now

For example:

  • 2 years ago
  • 3 months ago
  • 1 day ago
  • 30 seconds ago
  • Just now
  • 1 day from now
  • 5 months from now
  • 3 years from now

This method also supports multi-language and will output in the current user's language, so long as the phrases in /wire/core/WireDateTime.php are translated in the language pack.

Usage

// basic usage
$string = $datetime->relativeTimeStr($ts);

// usage with all arguments
$string = $datetime->relativeTimeStr($ts, $abbreviate = false, bool $useTense = true);

Arguments

NameType(s)Description
tsint, string

Unix timestamp or date string

abbreviate (optional)bool, int, array

Whether to use abbreviations for shorter strings.

  • Specify boolean TRUE for abbreviations (abbreviated where common, not always different from non-abbreviated)
  • Specify integer 1 for extra short abbreviations (all terms abbreviated into shortest possible string)
  • Specify boolean FALSE or omit for no abbreviations.
  • Specify associative array of key=value pairs of terms to use for abbreviations. The possible keys are: just now, ago, from now, never, second, minute, hour, day, week, month, year, decade, seconds, minutes, hours, days, weeks, months, years, decades
useTense (optional)bool

Whether to append a tense like "ago" or "from now".

  • May be ok to disable in situations where all times are assumed in future or past.
  • In abbreviate=1 (shortest) mode, this removes the leading "+" or "-" from the string.

Return value

string

Formatted relative time string


Hooking $datetime->relativeTimeStr(…)

You can add your own hook events that are executed either before or after the $datetime->relativeTimeStr(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $datetime->relativeTimeStr(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('WireDateTime::relativeTimeStr', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $datetime = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $ts = $event->arguments(0);
  $abbreviate = $event->arguments(1);
  $useTense = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $ts);
  $event->arguments(1, $abbreviate);
  $event->arguments(2, $useTense);
});

Hooking after

The 'after' hooks are called immediately after each $datetime->relativeTimeStr(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('WireDateTime::relativeTimeStr', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $datetime = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $ts = $event->arguments(0);
  $abbreviate = $event->arguments(1);
  $useTense = $event->arguments(2);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$datetime methods and properties

API reference based on ProcessWire core version 3.0.148

Twitter updates

  • ProcessWire 3.0.153 (dev) focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the pages API variable), and we introduce a useful new pages API method— More
    20 March 2020
  • ProcessWire 3.0.152 core updates— This week we have some major improvements to our core date/time Inputfield, as well as a new ability to specify your own custom classes for Page objects— More
    6 March 2020
  • This week we’ve got a couple of really useful API-side improvements to the core in 3.0.151, including predefined image settings and static language translation improvements— More
    21 February 2020

Latest news

  • ProcessWire Weekly #307
    In the 307th issue of ProcessWire Weekly we're going to check out the latest dev branch updates, introduce some new third party modules, and more. Read on!
    Weekly.pw / 28 March 2020
  • ProcessWire 3.0.153 core updates
    This latest version of the core on the dev branch focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the $pages API variable), and we introduce a useful new $pages API method.
    Blog / 20 March 2020
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull