DateTimeInterface::format
DateTimeImmutable::format
DateTime::format
date_format
(PHP 5 >= 5.2.0, PHP 7, PHP 8)
DateTimeInterface::format -- DateTimeImmutable::format -- DateTime::format -- date_format — Returns date formatted according to given format
Description
Object-oriented style
$format): string$format): string$format): stringProcedural style
Returns date formatted according to given format.
Parameters
-
object -
Procedural style only: A DateTime object returned by date_create()
-
format -
The format of the outputted date string. See the formatting options below. There are also several predefined date constants that may be used instead, so for example
DATE_RSScontains the format string'D, d M Y H:i:s'.The following characters are recognized in the formatparameter stringformatcharacterDescription Example returned values Day --- --- dDay of the month, 2 digits with leading zeros 01to31DA textual representation of a day, three letters MonthroughSunjDay of the month without leading zeros 1to31l(lowercase 'L')A full textual representation of the day of the week SundaythroughSaturdayNISO 8601 numeric representation of the day of the week 1(for Monday) through7(for Sunday)SEnglish ordinal suffix for the day of the month, 2 characters st,nd,rdorth. Works well withjwNumeric representation of the day of the week 0(for Sunday) through6(for Saturday)zThe day of the year (starting from 0) 0through365Week --- --- WISO 8601 week number of year, weeks starting on Monday Example: 42(the 42nd week in the year)Month --- --- FA full textual representation of a month, such as January or March JanuarythroughDecembermNumeric representation of a month, with leading zeros 01through12MA short textual representation of a month, three letters JanthroughDecnNumeric representation of a month, without leading zeros 1through12tNumber of days in the given month 28through31Year --- --- LWhether it's a leap year 1if it is a leap year,0otherwise.oISO 8601 week-numbering year. This has the same value as Y, except that if the ISO week number (W) belongs to the previous or next year, that year is used instead.Examples: 1999or2003XAn expanded full numeric representation of a year, at least 4 digits, with -for years BCE, and+for years CE.Examples: -0055,+0787,+1999,+10191xAn expanded full numeric representation if requried, or a standard full numeral representation if possible (like Y). At least four digits. Years BCE are prefixed with a-. Years beyond (and including)10000are prefixed by a+.Examples: -0055,0787,1999,+10191YA full numeric representation of a year, at least 4 digits, with -for years BCE.Examples: -0055,0787,1999,2003,10191yA two digit representation of a year Examples: 99or03Time --- --- aLowercase Ante meridiem and Post meridiem amorpmAUppercase Ante meridiem and Post meridiem AMorPMBSwatch Internet time 000through999g12-hour format of an hour without leading zeros 1through12G24-hour format of an hour without leading zeros 0through23h12-hour format of an hour with leading zeros 01through12H24-hour format of an hour with leading zeros 00through23iMinutes with leading zeros 00to59sSeconds with leading zeros 00through59uMicroseconds. Note that date() will always generate 000000since it takes an int parameter, whereas DateTime::format() does support microseconds if DateTime was created with microseconds.Example: 654321vMilliseconds. Same note applies as for u.Example: 654Timezone --- --- eTimezone identifier Examples: UTC,GMT,Atlantic/AzoresI(capital i)Whether or not the date is in daylight saving time 1if Daylight Saving Time,0otherwise.ODifference to Greenwich time (GMT) without colon between hours and minutes Example: +0200PDifference to Greenwich time (GMT) with colon between hours and minutes Example: +02:00pThe same as P, but returnsZinstead of+00:00(available as of PHP 8.0.0)Example: +02:00TTimezone abbreviation, if known; otherwise the GMT offset. Examples: EST,MDT,+05ZTimezone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive. -43200through50400Full Date/Time --- --- cISO 8601 date 2004-02-12T15:19:21+00:00 r» RFC 2822/» RFC 5322 formatted date Example: Thu, 21 Dec 2000 16:01:07 +0200USeconds since the Unix Epoch (January 1 1970 00:00:00 GMT) See also time() Unrecognized characters in the format string will be printed as-is. The
Zformat will always return0when using gmdate().Note:
Since this function only accepts int timestamps the
uformat character is only useful when using the date_format() function with user based timestamps created with date_create().
Return Values
Returns the formatted date string on success.
Changelog
| Version | Description |
|---|---|
| 8.2.0 |
The format characters X and x
have been added.
|
| 8.0.0 |
Prior to this version, false was returned on failure.
|
| 8.0.0 |
The format character p has been added.
|
Examples
Example #1 DateTime::format() example
Object-oriented style
<?php
$date = new DateTime('2000-01-01');
echo $date->format('Y-m-d H:i:s');
?>
Procedural style
<?php
$date = date_create('2000-01-01');
echo date_format($date, 'Y-m-d H:i:s');
?>
The above example will output:
2000-01-01 00:00:00
Notes
This method does not use locales. All output is in English.
See Also
- date() - Format a Unix timestamp

