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 — Возвращает дату, отформатированную согласно переданному формату

Описание

Объектно-ориентированный стиль

public DateTimeInterface::format(string $format): string

public DateTimeImmutable::format(string $format): string

public DateTime::format(string $format): string

Процедурный стиль

date_format(DateTimeInterface $object, string $format): string

Возвращает строку даты, преобразованной согласно переданному формату.

Список параметров

object

Только для процедурного стиля: объект DateTime, который возвращает функция date_create().

format

Шаблон результирующей строки (string) с датой. Смотрите параметры форматирования ниже. Также существует несколько предопределённых констант даты/времени, которые могут быть использованы вместо этих параметров. Например: DATE_RSS заменяет шаблон 'D, d M Y H:i:s'.

**В параметре `format` распознаются следующие символы**
Символ в строке `format`	Описание	Пример возвращаемого значения
День	---	---
`d`	День месяца, 2 цифры с ведущим нулём	От `01` до `31`
`D`	Текстовое представление дня недели, 3 символа	От `Mon` до `Sun`
`j`	День месяца без ведущего нуля	От `1` до `31`
`l` (строчная 'L')	Полное наименование дня недели	От `Sunday` до `Saturday`
`N`	Порядковый номер дня недели в соответствии со стандартом ISO 8601	От `1` (понедельник) до `7` (воскресенье)
`S`	Английский суффикс порядкового числительного дня месяца, 2 символа	`st`, `nd`, `rd` или `th`. Применяют совместно с `j`
`w`	Порядковый номер дня недели	От `0` (воскресенье) до `6` (суббота)
`z`	Порядковый номер дня в году (начиная с 0)	От `0` до `365`
Неделя	---	---
`W`	Порядковый номер недели года в соответствии со стандартом ISO 8601; недели начинаются с понедельника	Например: `42` (42-я неделя года)
Месяц	---	---
`F`	Полное наименование месяца, например, January или March	От `January` до `December`
`m`	Порядковый номер месяца с ведущим нулём	От `01` до `12`
`M`	Сокращённое наименование месяца, 3 символа	От `Jan` до `Dec`
`n`	Порядковый номер месяца без ведущего нуля	От `1` до `12`
`t`	Количество дней в указанном месяце	От `28` до `31`
Год	---	---
`L`	Признак високосного года	`1`, если год високосный, иначе `0`.
`o`	Номер года в соответствии со стандартом ISO 8601. Имеет то же значение, что и `Y`, кроме случая, когда номер недели ISO (`W`) принадлежит предыдущему или следующему году; тогда будет использован год этой недели.	Примеры: `1999` или `2003`
`X`	Расширенное полное числовое представление года, не менее 4 цифр, с `-` для годов до нашей эры и `+` для годов нашей эры.	Примеры: `-0055`, `+0787`, `+1999`, `+10191`
`x`	Расширенное полное числовое представление, если требуется, или стандартное полное числовое представление, если возможно (например, `Y`). Не менее четырёх цифр. Для годов до нашей эры указан префикс `-`. У годов после (и включая) `10000` префикс `+`.	Примеры: `-0055`, `0787`, `1999`, `+10191`
`Y`	Полное числовое представление года, не менее 4 цифр, с `-` для годов до нашей эры.	Примеры: `-0055`, `0787`, `1999`, `2003`, `10191`
`y`	Номер года, 2 цифры	Примеры: `99`, `03`
Время	---	---
`a`	Ante meridiem (лат. «до полудня») или Post meridiem (лат. «после полудня») в нижнем регистре	`am` или `pm`
`A`	Ante meridiem или Post meridiem в верхнем регистре	`AM` или `PM`
`B`	Время в формате Интернет-времени (альтернативной системы отсчёта времени суток)	От `000` до `999`
`g`	Часы в 12-часовом формате без ведущего нуля	От `1` до `12`
`G`	Часы в 24-часовом формате без ведущего нуля	От `0` до `23`
`h`	Часы в 12-часовом формате с ведущим нулём	От `01` до `12`
`H`	Часы в 24-часовом формате с ведущим нулём	От `00` до `23`
`i`	Минуты с ведущим нулём	От `00` до `59`
`s`	Секунды с ведущим нулём	От `00` до `59`
`u`	Микросекунды. Учтите, что функция date() всегда будет возвращать значение `000000`, т. к. она принимает целочисленный (int) параметр, тогда как метод DateTime::format() поддерживает микросекунды, если объект DateTime создан с ними.	Например: `654321`
`v`	Миллисекунды. Замечание такое же, как и для `u`.	Пример: `654`
Часовой пояс	---	---
`e`	Идентификатор часового пояса	Примеры: `UTC`, `GMT`, `Atlantic/Azores`
`I` (заглавная i)	Признак летнего времени	`1`, если дата соответствует летнему времени, `0` в противном случае
`O`	Разница со временем по Гринвичу без двоеточия между часами и минутами	Например: `+0200`
`P`	Разница со временем по Гринвичу с двоеточием между часами и минутами	Например: `+02:00`
`p`	То же, что и `P`, но возвращает `Z` вместо `+00:00` (доступен, начиная с PHP 8.0.0)	Например: `Z` или `+02:00`
`T`	Аббревиатура часового пояса, если известна; в противном случае смещение по Гринвичу.	Примеры: `EST`, `MDT`, `+05`
`Z`	Смещение часового пояса в секундах. Для часовых поясов, расположенных западнее UTC, возвращаются отрицательные числа, а для расположенных восточнее UTC — положительные.	От `-43200` до `50400`
Полная дата/время	---	---
`c`	Дата в формате стандарта ISO 8601	2004-02-12T15:19:21+00:00
`r`	Дата в формате » RFC 222/» RFC 5322	Например: `Thu, 21 Dec 2000 16:01:07 +0200`
`U`	Количество секунд, прошедших с начала Эпохи Unix (1 января 1970 00:00:00 GMT)	Смотрите также time()

Любые другие символы, встреченные в строке-шаблоне, будут выведены в результирующую строку без изменений. Z всегда возвращает 0 при использовании gmdate().

Замечание:
Поскольку эта функция принимает в качестве параметра целочисленные (int) метки времени, форматирующий символ u будет полезен только при работе с функцией date_format() и пользовательскими метками времени, созданными функцией date_create().

Возвращаемые значения

Возвращает строку с отформатированной датой в случае успешного выполнения.

Список изменений

Версия	Описание
8.2.0	Добавлены символы форматирования `X` и `x`.
8.0.0	Добавлен символ форматирования `p`.

Примеры

Пример #1 Пример использования DateTimeInterface::format()

Объектно-ориентированный стиль

<?php
$date = new DateTimeImmutable('2000-01-01');
echo $date->format('Y-m-d H:i:s');
?>

Процедурный стиль

<?php
$date = date_create('2000-01-01');
echo date_format($date, 'Y-m-d H:i:s');
?>

Результат выполнения приведённого примера:

2000-01-01 00:00:00

Пример #2 Больше примеров

<?php
// установка часового пояса по умолчанию.
date_default_timezone_set('UTC');

// сейчас
$date = new DateTimeImmutable();

// Выведет что-то подобное: Wednesday
echo $date->format('l'), "\n";

// Выведет что-то подобное: Wednesday 19th of October 2022 08:40:48 AM
echo $date->format('l jS \o\f F Y h:i:s A'), "\n";

/* Использование констант в параметре format */
// Выведет что-то подобное: Wed, 19 Oct 2022 08:40:48 +0000
echo $date->format(DateTimeInterface::RFC2822), "\n";
?>

Можно предотвратить расширение распознанного символа в строке формата, экранировав его предшествующим обратным слешем. Если символ с обратным слешем уже образует специальную последовательность, его также может потребоваться экранировать.

Пример #3 Экранирование символов во время форматирования

<?php
$date = new DateTimeImmutable();

// Выведет что-то подобное: Wednesday the 19th
echo $date->format('l \t\h\e jS');
?>

Для форматирования дат на других языках, вместо метода DateTimeInterface::format() можно использовать метод IntlDateFormatter::format().

Примечания

Данный метод не использует настройки локали. Вывод производится на английском языке.

Смотрите также

date() - Форматирует временную метку Unix

add a note

User Contributed Notes 10 notes

down

112

craig dot constable at gmail dot com ¶

12 years ago


Using a datetime field from a mysql database e.g. "2012-03-24 17:45:12"

<?php

$result = mysql_query("SELECT `datetime` FROM `table`");
$row = mysql_fetch_row($result);
$date = date_create($row[0]);

echo date_format($date, 'Y-m-d H:i:s');
#output: 2012-03-24 17:45:12

echo date_format($date, 'd/m/Y H:i:s');
#output: 24/03/2012 17:45:12

echo date_format($date, 'd/m/y');
#output: 24/03/12

echo date_format($date, 'g:i A');
#output: 5:45 PM

echo date_format($date, 'G:ia');
#output: 05:45pm

echo date_format($date, 'g:ia \o\n l jS F Y');
#output: 5:45pm on Saturday 24th March 2012

?>

down

soul dot enforcer at gmail dot com ¶

10 years ago


For full reference of the supported format character and results,
see the documentation of date() :
http://www.php.net/manual/en/function.date.php

down

mesa dot fx at gmail dot com ¶

5 years ago


There is a bit confusing logic may appear using year week number:

<?php
echo (new \DateTime("2018-12-31 13:05:21"))->format("YW") . PHP_EOL;
?>

will output 201801, not 201901 nor 201852, because of strange ISO_8601-2004 standard: the  first  calendar  week  of  a  year  is  that  one  which  includes  the  first  Thursday  of  that  year, so this date (it is Monday) do belong to the first week of 2019 (this is why 'W' format gives 01), but internal timestamp is of 2018 (and 'Y' format obey this), therefore getting us unexpected result of 201801. So be careful when using this output with something important (i know projects where this was used to form MySQL partitions).

down

sparcbr at gmail dot com ¶

4 years ago


To add literal characteres youi can escape with backslash (\):

$date = new DateTime();
echo $date->format('Ymd\Thms');

down

daysnine at gmail dot com ¶

11 years ago


Seems like datetime::format does not really support microseconds as the documentation under date suggest it will.

Here is some code to generate a datetime with microseconds and timezone:

private function udate($format = 'u', $utimestamp = null) {
        if (is_null($utimestamp))
            $utimestamp = microtime(true);

        $timestamp = floor($utimestamp);
        $milliseconds = round(($utimestamp - $timestamp) * 1000000);

        return date(preg_replace('`(?<!\\\\)u`', $milliseconds, $format), $timestamp);
    }

echo udate('Y-m-d H:i:s.u T');
// Will output something like: 2014-01-01 12:20:24.42342 CET

down

-4

tuxedobob ¶

4 years ago


I'm actually not sure whether this is a bug, but here's something that tripped me up on PHP 7.3.

I have a date that looks like this: 'November 3, 2020 11:13 (CST)'

I tried to format it using this format string: 'F j, Y H:i (T)'

That didn't work.

What *did* work was the format string without the parentheses: 'F j, Y H:i T'. 

This string also parsed the timezone when the time zone *didn't* have parentheses surrounding it: 'November 3, 2020 11:13 CST'.

It seems as though the T token is a little greedy with surrounding parentheses, so don't include them in your format string.

down

-15

ca at agercon dot dk ¶

13 years ago


The date_format can be use to get the last day of February:

<?php 

function last_day_of_feb ($year) {
# The 0th day of a month is the same as the last day of the month before
        $ultimo_feb_str = $year . "-03-00"; 
        $ultimo_feb_date = date_create($ultimo_feb_str);
        $return = date_format($ultimo_feb_date, "Y-m-d");
        return $return;
}

echo last_day_of_feb(2011) . "\n"; # 2011-02-28
echo last_day_of_feb(2012) . "\n"; # 2011-02-29

?>

down

-32

prussell at cloudworksconsulting dot com ¶

10 years ago


The udate function is a great start, but the formatting of the milliseconds is a little off. If it is within the first 100000 microseconds then the string will be less than 6 characters, so 0.012435 will appear as 0.12345. The revision below fixes this.

function udate($strFormat = 'u', $uTimeStamp = null)
{

    // If the time wasn't provided then fill it in
    if (is_null($uTimeStamp))
    {
        $uTimeStamp = microtime(true);
    }

    // Round the time down to the second
    $dtTimeStamp = floor($uTimeStamp);

    // Determine the millisecond value
    $intMilliseconds = round(($uTimeStamp - $dtTimeStamp) * 1000000);
    // Format the milliseconds as a 6 character string
    $strMilliseconds = str_pad($intMilliseconds, 6, '0', STR_PAD_LEFT);

    // Replace the milliseconds in the date format string
    // Then use the date function to process the rest of the string
    return date(preg_replace('`(?<!\\\\)u`', $strMilliseconds, $strFormat), $dtTimeStamp);
}

down

-19

info at ibusweb dot com ¶

5 years ago


$saved_time="2019-03-09 14:25:20";
    $formated_saved_time = new DateTime($saved_time);
    $current_time = new DateTime();
    $interval = $current_time->diff($formated_saved_time);
  
      if (!empty($interval->format('%a'))){
       $time_difference=$interval->format('%a days ago');
        } elseif ($formated_saved_time->format('d') != $current_time->format('d')){
             $time_difference="yesterday";
             }elseif (!empty($interval->format('%h'))){
                     $time_difference=$interval->format('%h hr, %i min ago');
                     } elseif (!empty($interval->format('%i'))){
                              $time_difference=$interval->format('%i min ago');
                              } elseif (!empty($interval->format('%s'))){
                                $time_difference=$interval->format('%s sec ago');
  } 

output ----- posted 4 hr, 12 min ago at 2019-03-09 14:25:20

see the code in action here 
https://eval.in/1081921

down

-55

chris at codewiz dot biz ¶

10 years ago


I believe this is a bug but its note-worthy if it is intended (I am using PHP 5.5.3).

$ php --version

PHP Warning:  Module 'xdebug' already loaded in Unknown on line 0
PHP 5.5.3-1ubuntu2.1 (cli) (built: Dec 12 2013 04:24:35) 
Copyright (c) 1997-2013 The PHP Group
Zend Engine v2.5.0, Copyright (c) 1998-2013 Zend Technologies
    with Xdebug v2.2.3, Copyright (c) 2002-2013, by Derick Rethans
    with Zend OPcache v7.0.3-dev, Copyright (c) 1999-2013, by Zend Technologies

What is happening:

DateTime()->format() will modify the timezone. So do not expect the public date property to be returned (format mask applied) based on the current public timezone property. format will decide that when calling ->format() it will use the server timezone which eliminates all usefulness of ->setTimezone().

<?php
            $nowUtc = new \DateTime( 'now',  new \DateTimeZone( 'UTC' ) );
            echo '$nowUtc'.PHP_EOL;
            var_dump($nowUtc);
            $nowUtc = new \DateTime( 'now',  new \DateTimeZone( 'UTC' ) );
            echo '$nowUtc->format(\'Y-m-d h:i:s\')'.PHP_EOL;
            var_dump($nowUtc->format('Y-m-d h:i:s'));
            $nowUtc->setTimezone( new \DateTimeZone( 'Australia/Sydney' ) );
            echo '$nowUtc->setTimezone( new \DateTimeZone( \'Australia/Sydney\' ) )'.PHP_EOL;
            var_dump($nowUtc);
            echo '$nowUtc->format(\'Y-m-d h:i:s\')'.PHP_EOL;
            var_dump($nowUtc->format('Y-m-d h:i:s'));exit;
?>

outputs;

$nowUtc

object(DateTime)[2607]
  public 'date' => string '2014-02-13 02:42:48' (length=19)
  public 'timezone_type' => int 3
  public 'timezone' => string 'UTC' (length=3)

$nowUtc->format('Y-m-d h:i:s')

string '2014-02-13 02:42:48' (length=19)

$nowUtc->setTimezone( new \DateTimeZone( 'Australia/Sydney' ) )

object(DateTime)[2608]
  public 'date' => string '2014-02-13 13:42:48' (length=19)
  public 'timezone_type' => int 3
  public 'timezone' => string 'Australia/Sydney' (length=16)

$nowUtc->format('Y-m-d h:i:s')

string '2014-02-13 01:42:48' (length=19) // expected 2014-02-13 13:42:48 based on Australia/Sydney - what is 2014-02-13 01:42:48 from anyway!

add a note