wireRelativeTimeStr() function

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

Examples: “1 day ago”, “30 seconds ago”, “just now”, etc.

This is the procedural version of $datetime->relativeTimeStr().

Based upon: http://www.php.net/manual/en/function.time.php#89415

Usage

// basic usage
$string = wireRelativeTimeStr($ts);

// usage with all arguments
$string = wireRelativeTimeStr($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

See Also


Functions methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #518
    The 518th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 13 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani