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.

Common / Advanced

Common

Name Return Summary  
$datetime->date() string or bool Format a date, using PHP date(), strftime() or other special strings (see arguments).
$datetime->relativeTimeStr($ts) string Given a unix timestamp (or date string), returns a formatted string indicating the time relative to now
$datetime->stringToTimestamp(string $str, string $format) int Given a date/time string and expected format, convert it to a unix timestamp

Advanced

Name Return Summary  
$datetime->convertDateFormat(string $format, string $type) string Given a PHP date() format, convert it to either 'js', 'strftime' or 'regex' format
$datetime->getDateFormats() array Return all predefined PHP date() formats for use as dates
$datetime->getTimeFormats() array Return 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: