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 — Retorna a data formatada de acordo com um formato informado

Descrição

Estilo orientado a objetos

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

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

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

Estilo procedural

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

Retorna a data formatada de acordo com um formato informado.

Parâmetros

object

Somente no estilo procedural: Um objeto DateTime retornado por date_create()

format

O formato da string de data resultante. Veja abaixo as opções de formatação. Existem também várias constantes de data predefinidas que podem ser usadas, por exemplo, DATE_RSS contém a string de formatação 'D, d M Y H:i:s'.

**Os seguintes caracteres são reconhecidos na string do parâmetro `format`**
Caractere `format`	Descrição	Exemplo de valores retornados
Dia	---	---
`d`	Dia do mês, 2 digits com zeros à esquerda	`01` a `31`
`D`	Uma representação textual de um dia, três letras	`Mon` a `Sun`
`j`	Dia do mês sem zeros à esquerda	`1` a `31`
`l` (lowercase 'L')	Uma representação textual completa do dia da semana	`Sunday` a `Saturday`
`N`	Representação numérica ISO 8601 do dia da semana	`1` (para segunda-feira) a `7` (para domingo)
`S`	Sufixo ordinal inglês para o dia do mês, 2 caracteres	`st`, `nd`, `rd` ou `th`. Funciona bem com `j`
`w`	Representação numérica do dia da semana	`0` (para domingo) a `6` (para sábado)
`z`	O dia do ano (começando em 0)	`0` a `365`
Semana	---	---
`W`	Número da semana do mês ISO 8601, semanas começando na segunda-feira	Exemplo: `42` (a 42ª semana no ano)
Mês	---	---
`F`	Uma representação textual completa do mês, como January ou March	`January` a `December`
`m`	Representação numérica de um mês, com zeros à esquerda	`01` a `12`
`M`	Uma representação textual curta de um mês, três letras	`Jan` a `Dec`
`n`	Representação numérica de um mês, sem zeros à esquerda	`1` a `12`
`t`	Número de dias em determinado mês	`28` a `31`
Ano	---	---
`L`	Se é um ano bissexto	`1` se for um ano bissexto, `0` caso contrário.
`o`	Ano de numeração da semana ISO 8601. Tem o mesmo valor que `Y`, exceto que se o número da semana ISO (`W`) pertencer ao ano anterior ou seguinte, esse ano será usado.	Exemplos: `1999` ou `2003`
`X`	Uma representação numérica completa expandida de um ano, pelo menos 4 dígitos, com `-` para anos AEC, e `+` para anos EC.	Exemplos: `-0055`, `+0787`, `+1999`, `+10191`
`x`	Uma representação numérica completa expandida se necessário, ou uma representação numérica completa padrão se possível (como `Y`). Pelo menos quatro dígitos. Anos AEC são prefixados com um `-`. Anos além de (e incluindo) `10000` são prefixados com um `+`.	Exemplos: `-0055`, `0787`, `1999`, `+10191`
`Y`	Uma representação numérica completa de um ano, pelo menos 4 dígitos, com `-` para anos AEC.	Exemplos: `-0055`, `0787`, `1999`, `2003`, `10191`
`y`	Uma representação de dois digitos do ano	Exemplos: `99` ou `03`
Hora	---	---
`a`	Ante meridiem e Post meridiem em letras minúsculas	`am` ou `pm`
`A`	Ante meridiem e Post meridiem em letras maiúsculas	`AM` ou `PM`
`B`	Internet Time da Swatch	`000` a `999`
`g`	Formato de 12 horas de uma hora sem zeros à esquerda	`1` a `12`
`G`	Formato de 24 horas de uma hora sem zeros à esquerda	`0` a `23`
`h`	Formato de 12 horas de uma hora com zeros à esquerda	`01` a `12`
`H`	Formato de 24 horas de uma hora com zeros à esquerda	`00` a `23`
`i`	Minutos com zeros à esquerda	`00` to `59`
`s`	Segundos com zeros à esquerda	`00` a `59`
`u`	Microssegundos. Note que date() sempre irá gerar `000000` uma vez que leva um parâmetro int, enquanto DateTime::format() suporta microssegundos se DateTime foi criada com microssegundos.	Exemplo: `654321`
`v`	Millisegundos. A mesma nota se aplica como no `u`.	Exemplo: `654`
Fuso horário	---	---
`e`	Identificador do fuso horário	Exemplos: `UTC`, `GMT`, `Atlantic/Azores`
`I` (i maiúsculo)	Se a data está ou não no horário de verão	`1` se está no horário de verão, `0` caso contrário.
`O`	Diferença para o horário de Greenwich (GMT) sem dois pontos entre horas e minutos	Example: `+0200`
`P`	Diferença para o horário de Greenwich (GMT) com dois pontos entre horas e minutos	Exemplo: `+02:00`
`p`	O mesmo que `P`, mas retorna `Z` em vez de `+00:00` (disponível a partir do PHP 8.0.0)	Exemplo: `Z` or `+02:00`
`T`	Abreviação do fuso horário, se conhecido; ou o deslocamento GMT caso contrário.	Exemplos: `EST`, `MDT`, `+05`
`Z`	Deslocamento do fuso horário em segundos. O deslocamento para fusos a oeste de UTC é sempre negativo, e para aqueles a leste de UTC é sempre positivo.	`-43200` a `50400`
Data/Hora completa	---	---
`c`	Data ISO 8601	2004-02-12T15:19:21+00:00
`r`	Data formatada » RFC 2822/» RFC 5322	Exemplo: `Thu, 21 Dec 2000 16:01:07 +0200`
`U`	Segundos desde a Era Unix (1 de janeiro de 1970 00:00:00 GMT)	Veja também time()

Caracteres não reconhecidos na string de formatação serão impressos como estão. O formato Z sempre retornará 0 ao usar gmdate().

Nota:
Uma vez que esta função só aceita timestamps int, o caractere de formato u só é útil ao usar a função date_format() com timestamps baseados no usuário criados com date_create().

Valor Retornado

Retorna a data formatada em caso de sucesso.

Registro de Alterações

Versão	Descrição
8.2.0	Os caracteres de formatação `X` e `x` foram adicionados.
8.0.0	O caractere de formatação `p` foi adicionado.

Exemplos

Exemplo #1 Exemplo de DateTimeInterface::format()

Estilo orientado a objetos

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

Estilo procedural

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

O exemplo acima produzirá:

2000-01-01 00:00:00

Exemplo #2 Mais exemplos

<?php
// define o fuso horário padrão a ser usado.
date_default_timezone_set('UTC');

// agora
$date = new DateTimeImmutable();

// Imprime algo como: Wednesday
echo $date->format('l'), "\n";

// Imprime algo como: Wednesday 19th of October 2022 08:40:48 AM
echo $date->format('l jS \o\f F Y h:i:s A'), "\n";

/* usa as constantes no parâmetro format */
// Imprime algo como: Wed, 19 Oct 2022 08:40:48 +0000
echo $date->format(DateTimeInterface::RFC2822), "\n";
?>

Você pode previnir um caractere reconhecido na string de formação de ser expandido escapando-o com uma barra invertida antes. Se o caractere com uma barra invertida já for uma sequência especial, você pode escapar também a barra invertida.

Exemplo #3 Escapando caracteres ao formatar

<?php
$date = new DateTimeImmutable();

// prints something like: Wednesday the 19th
echo $date->format('l \t\h\e jS');
?>

Para formatar datas em outras línguas, IntlDateFormatter::format() pode ser usado em vez do DateTimeInterface::format().

Notas

Este método não utiliza configurações baseadas no idioma. Toda a saída será em Inglês.

Veja Também

IntlDateFormatter::format() - Formata data/horário como uma string

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 ¶

6 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