$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 #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits