$datetime API variable / WireDateTime class

The $datetime API variable provides helpers for working with dates/times and conversion between formats.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireDateTime class also inherits all the methods and properties of: Wire.

Show $var?             Show args?        

Common

NameReturnSummary 
$datetime->date()
string boolFormat a date, using PHP date(), strftime() or other special strings (see arguments). 
$datetime->elapsedTimeStr($start)
string arrayRender an elapsed time string 
$datetime->relativeTimeStr($ts)
stringGiven a unix timestamp (or date string), returns a formatted string indicating the time relative to now
$datetime->strftime(string $format)
string falsestrftime() replacement function that works in PHP 8.1+ (though not locale aware) 
$datetime->stringToTimestamp(string $str, string $format)
intGiven a date/time string and expected format, convert it to a unix timestamp 
$datetime->strtotime(string $str)
false int nullParse about any English textual datetime description into a Unix timestamp using PHP’s strtotime() 

Advanced

NameReturnSummary 
$datetime->convertDateFormat(string $format, string $type)
stringGiven a PHP date() format, convert it to either 'js', 'strftime' or 'regex' format 
$datetime->getDateFormats()
arrayReturn all predefined PHP date() formats for use as dates 
$datetime->getTimeFormats()
arrayReturn all predefined PHP date() formats for use as times 

Additional methods and properties

In addition to the methods and properties above, WireDateTime also inherits the methods and properties of these classes:

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