$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

  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020
  • If you haven't seen it yet, be sure to check out this great infographic by @teppokoivula in ProcessWire Weekly #294— How ProcessWire professionals work—the results of our recent weekly polls summarised: weekly.pw/issue/294/#how…
    3 January 2020
  • Today we have a new master version released, 3.0.148! There are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we take a closer look at what’s new, how to upgrade, & more— More
    3 January 2020

Latest news

  • ProcessWire Weekly #297
    In the 297th issue of ProcessWire Weekly we're going to check out the latest core updates (ProcessWire 3.0.149) and introduce a new third party module called StaticWire. Read on!
    Weekly.pw / 18 January 2020
  • ProcessWire 3.0.148 new master
    Today we have a new master version released, version 3.0.148! The last master version was 3.0.123, so there are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we’ll take a closer look at what’s new, how to upgrade, and more.
    Blog / 3 January 2020
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.