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

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer