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

Newest forum posts

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.