$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.

Common
Advanced

Common

Name	Return	Summary
$datetime->date() $datetime->date() $datetime->date($format = '', $ts = null)	`string` `bool`	Format a date, using PHP date(), strftime() or other special strings (see arguments).
$datetime->elapsedTimeStr() $datetime->elapsedTimeStr($start) $datetime->elapsedTimeStr($start, $stop = null, $abbreviate = false, array $options = [])	`string` `array`	Render an elapsed time string
$datetime->relativeTimeStr() $datetime->relativeTimeStr($ts) $datetime->relativeTimeStr($ts, $abbreviate = false, bool $useTense = true)	`string`	Given a unix timestamp (or date string), returns a formatted string indicating the time relative to now
$datetime->strftime() $datetime->strftime(string $format) $datetime->strftime(string $format, $timestamp = null)	`string` `false`	strftime() replacement function that works in PHP 8.1+ (though not locale aware)
$datetime->stringToTimestamp() $datetime->stringToTimestamp(string $str, string $format) $datetime->stringToTimestamp(string $str, string $format)	`int`	Given a date/time string and expected format, convert it to a unix timestamp
$datetime->strtotime() $datetime->strtotime(string $str) $datetime->strtotime(string $str, $options = [])	`false` `int` `null`	Parse about any English textual datetime description into a Unix timestamp using PHP’s strtotime()

Advanced

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

Wire

API reference based on ProcessWire core version 3.0.236

$datetime API variable / WireDateTime class

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

Common

Advanced

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news