$datetime->date() method

Format a date, using PHP date(), strftime() or other special strings (see arguments).

This is designed to work the same way as PHP's date() but be able to accept any common format used in ProcessWire. This is helpful for reducing code in places where you might have logic determining when to use date(), strftime(), wireRelativeTimeStr() or some other date formatting function.

Example

// Output the current date/time in relative format
echo $datetime->date('relative');

Usage

// basic usage
$string = $datetime->date();

// usage with all arguments
$string = $datetime->date($format = '', $ts = null);

Arguments

NameType(s)Description
format (optional)string, int

Use one of the following:

  • PHP date format
  • PHP strftime format (detected by presence of a '%' somewhere in it)
  • relative for a relative date/time string.
  • relative- for a relative date/time string with no tense.
  • rel for an abbreviated relative date/time string.
  • rel- for an abbreviated relative date/time string with no tense.
  • r for an extra-abbreviated relative date/time string.
  • r- for an extra-abbreviated relative date/time string with no tense.
  • ts makes it return a unix timestamp
  • blank string makes it use the system date format ($config->dateFormat)
  • If given an integer and no second argument specified, it is assumed to be the second ($ts) argument.
ts (optional)int, string, null

Optionally specify the date/time stamp or strtotime() compatible string. If not specified, current time is used.

Return value

string bool

Formatted date/time, or boolean false on failure


$datetime methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #582
    The 582nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 5 July 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK