DateTimeInterface::formatDateTimeImmutable::formatDateTime::formatdate_formatReturns date formatted according to given format
&reftitle.description;
&style.oop;publicstringDateTimeInterface::formatstringformatpublicstringDateTimeImmutable::formatstringformatpublicstringDateTime::formatstringformat&style.procedural;stringdate_formatDateTimeInterfaceobjectstringformat
Returns date formatted according to given format.
&reftitle.parameters;
&date.datetime.description;
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_RSS
contains the format string 'D, d M Y H:i:s'.
The following characters are recognized in the
format parameter stringformat characterDescriptionExample returned valuesDay------dDay of the month, 2 digits with leading zeros01 to 31DA textual representation of a day, three lettersMon through SunjDay of the month without leading zeros1 to 31l (lowercase 'L')A full textual representation of the day of the weekSunday through SaturdayNISO 8601 numeric representation of the day of the week1 (for Monday) through 7 (for Sunday)SEnglish ordinal suffix for the day of the month, 2 charactersst, nd, rd or
th. Works well with jwNumeric representation of the day of the week0 (for Sunday) through 6 (for Saturday)zThe day of the year (starting from 0)0 through 365Week------WISO 8601 week number of year, weeks starting on MondayExample: 42 (the 42nd week in the year)Month------FA full textual representation of a month, such as January or MarchJanuary through DecembermNumeric representation of a month, with leading zeros01 through 12MA short textual representation of a month, three lettersJan through DecnNumeric representation of a month, without leading zeros1 through 12tNumber of days in the given month28 through 31Year------LWhether it's a leap year1 if it is a leap year, 0 otherwise.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: 1999 or 2003XAn 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 required, or a
standard full numeral representation if possible (like
Y). At least four digits. Years BCE are prefixed
with a -. Years beyond (and including)
10000 are 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 yearExamples: 99 or 03Time------aLowercase Ante meridiem and Post meridiemam or pmAUppercase Ante meridiem and Post meridiemAM or PMBSwatch Internet time000 through 999g12-hour format of an hour without leading zeros1 through 12G24-hour format of an hour without leading zeros0 through 23h12-hour format of an hour with leading zeros01 through 12H24-hour format of an hour with leading zeros00 through 23iMinutes with leading zeros00 to 59sSeconds with leading zeros00 through 59u
Microseconds. Note that
date will always generate
000000 since it takes an int
parameter, whereas DateTimeInterface::format does
support microseconds if an object of type
DateTimeInterface was created with microseconds.
Example: 654321v
Milliseconds. Same note applies as for
u.
Example: 654Timezone------eTimezone identifierExamples: UTC, GMT, Atlantic/AzoresI (capital i)Whether or not the date is in daylight saving time1 if Daylight Saving Time, 0 otherwise.ODifference to Greenwich time (GMT) without colon between hours and minutesExample: +0200PDifference to Greenwich time (GMT) with colon between hours and minutesExample: +02:00p
The same as P, but returns Z instead of +00:00
(available as of PHP 8.0.0)
Examples: Z or +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.-43200 through 50400Full Date/Time------cISO 8601 date. Only compatible with the non-expanded format (up to year 9999). Later dates will result in an invalid string. For later dates and expanded format, see x and X.2004-02-12T15:19:21+00:00rRFC 2822/RFC 5322 formatted dateExample: 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 Z format will always return
0 when using gmdate.
Since this function only accepts int timestamps the
u format character is only useful when using the
date_format function with user based timestamps
created with date_create.
&reftitle.returnvalues;
Returns the formatted date string on success.
&reftitle.changelog;
&Version;&Description;8.2.0
The format characters X and x
have been added.
8.0.0
The format character p has been added.
&reftitle.examples;
DateTimeInterface::format example&style.oop;
format('Y-m-d H:i:s');
?>
]]>
&example.outputs;
&style.procedural;
]]>
&example.outputs;
More examples
format('l'), "\n";
// Prints something like: Wednesday 19th of October 2022 08:40:48 AM
echo $date->format('l jS \o\f F Y h:i:s A'), "\n";
/* use the constants in the format parameter */
// prints something like: Wed, 19 Oct 2022 08:40:48 +0000
echo $date->format(DateTimeInterface::RFC2822), "\n";
?>
]]>
You can prevent a recognized character in the format string from being
expanded by escaping it with a preceding backslash. If the character with
a backslash is already a special sequence, you may need to also escape
the backslash.
Escaping characters while formatting
format('l \t\h\e jS');
?>
]]>
To format dates in other languages,
IntlDateFormatter::format
can be used instead of DateTimeInterface::format.
&reftitle.notes;
This method does not use locales. All output is in English.
&reftitle.seealso;
IntlDateFormatter::format