PHP マニュアル: ロケールの設定に基づいてローカルな日付・時間をフォーマットする

説明

#[\Deprecated] stringfalse strftime(string $format, intnull $timestamp = null)

ローカルの時刻・日付を、ロケール設定にもとづいてフォーマットします。月および曜日の名前、およびその他の言語依存の文字列は、 setlocale で設定された現在のロケールを尊重して表示されます。

警告

使用する C ライブラリで、すべての変換指定子がサポートされているとは限りません。そのような場合、該当する変換指定子は PHP の strftime ではサポートされません。また、全てのプラットフォームが負のタイムスタンプをサポートしているわけではないため、 Unix Epoch (1970 年 1 月 1 日）以前の日付を扱えないかもしれません。つまり、Windows や一部の Linux ディストリビューション、そしてその他のごく一部のオペレーティングシステム上では %e、%T、%R および %D (あるいはこれ以外も) が Jan 1, 1970 より前の日付について動作しないということです。 Windwos システム上でサポートされる変換指定子の概要については、 » MSDN に掲載されています。 Instead use the IntlDateFormatter::format method.

パラメータ

format

**次の変換指定子が `format` パラメータ用の文字列として認識されます**
`format`	説明	戻り値の例
日	---	---
`%a`	短縮された曜日の名前	`Sun` から `Sat`
`%A`	完全な曜日の名前	`Sunday` から `Saturday`
`%d`	10 進数で 2 桁の日付 (先頭のゼロつき)	`01` から `31`
`%e`	1 桁の場合は先頭にスペースをいれた日付。 Windows ではそのようには実装されていません。詳細は以下を参照ください。	`1` から `31`
`%j`	3 桁で先頭にゼロを含む年間での日付	`001` から `366`
`%u`	ISO-8601 数値表現であらわした曜日	`1` (月曜日) から `7` (日曜日)
`%w`	数値表現であらわした曜日	`0` (日曜日) から `6` (土曜日)
週	---	---
`%U`	指定した年の週番号。最初の日曜日を第一週の開始日とする	`13` (年間の第 13 週の場合)
`%V`	ISO-8601:1988 で規定された、指定した年の週番号。週の開始日は月曜日で、第 1 週は少なくとも 4 日はあることになる	`01` から `53` (53 は年をまたがる週になります)
`%W`	その年の週番号の数値表現。最初の月曜日を最初の週の初日とする	`46` (46 番目の週の場合。開始日は月曜日)
月	---	---
`%b`	現在のロケールに基づく短縮された月の名前	`Jan` から `Dec`
`%B`	現在のロケールに基づく完全な月の名前	`January` から `December`
`%h`	現在のロケールに基づく短縮された月の名前 (%b のエイリアス)	`Jan` から `Dec`
`%m`	2 桁であらわした月	`01` (1 月) から `12` (12 月)
年	---	---
`%C`	2 桁であらわした世紀 (年を 100 で割り、整数に丸めたもの)	20 正規の場合は `19`
`%g`	2 桁であらわした年。ISO-8601:1988 標準形式 (%V を参照)	2009 年 1 月 6 日の場合は `09`
`%G`	%g の 4 桁完全版	2009 年 1 月 3 日の場合は `2009`
`%y`	2 桁であらわした年	2009 年の場合は `09`、1979 年の場合は `79`
`%Y`	4 桁であらわした年	`2038`
時	---	---
`%H`	2 桁であらわした 24 時間制の時間	`00` から `23`
`%k`	24 時間制の時間で、1 桁の場合は先頭にスペースをつけたもの	`0` から `23`
`%I`	2 桁であらわした 12 時間制の時間	`01` から `12`
`%l (小文字の 'L')`	12 時間制の時間で、1 桁の場合は先頭にスペースをつけたもの	`1` から `12`
`%M`	2 桁であらわした分	`00` から `59`
`%p`	指定した時刻に応じた大文字の 'AM' あるいは 'PM'	00:31 なら `AM`、22:23 なら `PM`。正確な結果はオペレーティングシステムに依存します。 (`a.m.` のような) 小文字やドット付きの結果を返すこともあります。
`%P`	指定した時刻に応じた小文字の 'am' あるいは 'pm'	00:31 なら `am`、22:23 なら `pm`。全てのオペレーティングシステムでサポートされているとは限りません。
`%r`	"%I:%M:%S %p" と同じ	21:34:17 なら `09:34:17 PM`
`%R`	"%H:%M" と同じ	12:35 AM なら `00:35`、4:44 PM なら `16:44`
`%S`	2 桁であらわした秒	`00` から `59`
`%T`	"%H:%M:%S" と同じ	09:34:17 PM なら `21:34:17`
`%X`	ロケールに基づいた時刻の表現。日付は含まない	`03:59:16` あるいは `15:59:16`
`%z`	タイムゾーンオフセット。Windows では違う実装になっています。詳細は後述します。	東海岸時刻なら `-0500`
`%Z`	タイムゾーンの略称。Windows では違う実装になっています。詳細は後述します。	東海岸時刻なら `EST`
タイムスタンプ	---	---
`%c`	現在のロケールにもとづく日付と時間の表現	2009 年 2 月 5 日午前 12:45:10 なら `Tue Feb 5 00:45:10 2009`
`%D`	"%m/%d/%y" と同じ	2009 年 2 月 5 日なら `02/05/09`
`%F`	"%Y-%m-%d" と同じ (データベースのタイムスタンプとして一般的)	2009 年 2 月 5 日なら `2009-02-05`
`%s`	Unix エポックからのタイムスタンプ (time 関数と同じ)	1979 年 9 月 10 日午前 08:40:00 なら `305815200`
`%x`	現在のロケールにもとづく日付の表現 (時間は除く)	2009 年 2 月 5 日なら `02/05/09`
その他	---	---
`%n`	改行文字 ("\n")	---
`%t`	タブ文字 ("\t")	---
`%%`	パーセント文字 ("%")	---

警告

ISO-9889:1999 に反して、Sun Solaris は日曜日を 1 としています。そのため、%u はこのマニュアルの説明どおりに機能しないかもしれません。

警告

Windows 限定:

Windows 上では %e に対応していません。この値が欲しければ、代わりに %#d を使いましょう。クロスプラットフォーム対応の関数を書く方法をこの後の例で示します。

%z と %Z は、どちらもタイムゾーン名を返します。オフセットや略称は返しません。

警告

macOS と musl 限定: %P 修飾子は macOS 版の実装ではサポートされていません。

timestamp

オプションのパラメータ timestamp は、 int 型の Unix タイムスタンプです。 timestamp が指定されなかったり、null だった場合のデフォルト値は、現在の時刻です。言い換えると、デフォルトは time の返り値となります。

戻り値

指定した timestamp または timestamp が指定されていない場合に現在のローカル時間を用いて、指定したフォーマット文字列に基づき文字列をフォーマットして返します。月および曜日の名前、およびその他の言語依存の文字列は、 setlocale で設定された現在のロケールを尊重して表示されます。この関数は、format が空だったり、サポートされていない変換指定子が含まれていたり、返される文字列の長さが 4095 より大きい場合は、false を返します。

エラー / 例外

すべての日付/時刻関数は、有効なタイムゾーンが設定されていない場合に E_WARNING を発生させます。 date_default_timezone_set も参照ください。

出力内容は元となった C ライブラリに依存するため、サポートしていない変換指定子もあります。 Windows では、対応していない変換指定子を渡すと 5 つの E_WARNING メッセージが出て false を返します。その他のオペレーティングシステムでは特に E_WARNING メッセージは出ず、変換指定子が (変換されずに) そのまま出力されます。

変更履歴

バージョン	説明
8.0.0	`timestamp` は、nullable になりました。

例

この例は、それぞれのロケールがシステムにインストールされている場合にのみ動作します。

例1 strftime のロケールの例

<?php
setlocale(LC_TIME, "C");
echo strftime("%A");
setlocale(LC_TIME, "fi_FI");
echo strftime(" in Finnish is %A,");
setlocale(LC_TIME, "fr_FR");
echo strftime(" in French %A and");
setlocale(LC_TIME, "de_DE");
echo strftime(" in German %A.\n");
?>

例2 ISO 8601:1988 の週番号の例

<?php
/*     December 2002 / January 2003
ISOWk  M   Tu  W   Thu F   Sa  Su
----- ----------------------------
51     16  17  18  19  20  21  22
52     23  24  25  26  27  28  29
1      30  31   1   2   3   4   5
2       6   7   8   9  10  11  12
3      13  14  15  16  17  18  19   */

// Outputs: 12/28/2002 - %V,%G,%Y = 52,2002,2002
echo "12/28/2002 - %V,%G,%Y = " . strftime("%V,%G,%Y", strtotime("12/28/2002")) . "\n";

// Outputs: 12/30/2002 - %V,%G,%Y = 1,2003,2002
echo "12/30/2002 - %V,%G,%Y = " . strftime("%V,%G,%Y", strtotime("12/30/2002")) . "\n";

// Outputs: 1/3/2003 - %V,%G,%Y = 1,2003,2003
echo "1/3/2003 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("1/3/2003")) . "\n";

// Outputs: 1/10/2003 - %V,%G,%Y = 2,2003,2003
echo "1/10/2003 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("1/10/2003")) . "\n";



/*     December 2004 / January 2005
ISOWk  M   Tu  W   Thu F   Sa  Su
----- ----------------------------
51     13  14  15  16  17  18  19
52     20  21  22  23  24  25  26
53     27  28  29  30  31   1   2
1       3   4   5   6   7   8   9
2      10  11  12  13  14  15  16   */

// Outputs: 12/23/2004 - %V,%G,%Y = 52,2004,2004
echo "12/23/2004 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("12/23/2004")) . "\n";

// Outputs: 12/31/2004 - %V,%G,%Y = 53,2004,2004
echo "12/31/2004 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("12/31/2004")) . "\n";

// Outputs: 1/2/2005 - %V,%G,%Y = 53,2004,2005
echo "1/2/2005 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("1/2/2005")) . "\n";

// Outputs: 1/3/2005 - %V,%G,%Y = 1,2005,2005
echo "1/3/2005 - %V,%G,%Y = " . strftime("%V,%G,%Y",strtotime("1/3/2005")) . "\n";

?>

例3 %e 修飾子を使う、クロスプラットフォーム対応の例

<?php

// Jan 1: はこのようになります。'%e%1%' (%%, e, %%, %e, %%)
$format = '%%e%%%e%%';

// Windows かどうかをチェックし、%e 修飾子を
// 適切に置換します
if (strtoupper(substr(PHP_OS, 0, 3)) == 'WIN') {
    $format = preg_replace('#(?<!%)((?:%%)*)%e#', '\1%#d', $format);
}

echo strftime($format);
?>

例4 すべての書式の表示

<?php

// 書式についての説明
$strftimeFormats = array(
    'A' => 'A full textual representation of the day',
    'B' => 'Full month name, based on the locale',
    'C' => 'Two digit representation of the century (year divided by 100, truncated to an integer)',
    'D' => 'Same as "%m/%d/%y"',
    'E' => '',
    'F' => 'Same as "%Y-%m-%d"',
    'G' => 'The full four-digit version of %g',
    'H' => 'Two digit representation of the hour in 24-hour format',
    'I' => 'Two digit representation of the hour in 12-hour format',
    'J' => '',
    'K' => '',
    'L' => '',
    'M' => 'Two digit representation of the minute',
    'N' => '',
    'O' => '',
    'P' => 'lower-case "am" or "pm" based on the given time',
    'Q' => '',
    'R' => 'Same as "%H:%M"',
    'S' => 'Two digit representation of the second',
    'T' => 'Same as "%H:%M:%S"',
    'U' => 'Week number of the given year, starting with the first Sunday as the first week',
    'V' => 'ISO-8601:1988 week number of the given year, starting with the first week of the year with at least 4 weekdays, with Monday being the start of the week',
    'W' => 'A numeric representation of the week of the year, starting with the first Monday as the first week',
    'X' => 'Preferred time representation based on locale, without the date',
    'Y' => 'Four digit representation for the year',
    'Z' => 'The time zone offset/abbreviation option NOT given by %z (depends on operating system)',
    'a' => 'An abbreviated textual representation of the day',
    'b' => 'Abbreviated month name, based on the locale',
    'c' => 'Preferred date and time stamp based on local',
    'd' => 'Two-digit day of the month (with leading zeros)',
    'e' => 'Day of the month, with a space preceding single digits',
    'f' => '',
    'g' => 'Two digit representation of the year going by ISO-8601:1988 standards (see %V)',
    'h' => 'Abbreviated month name, based on the locale (an alias of %b)',
    'i' => '',
    'j' => 'Day of the year, 3 digits with leading zeros',
    'k' => 'Hour in 24-hour format, with a space preceding single digits',
    'l' => 'Hour in 12-hour format, with a space preceding single digits',
    'm' => 'Two digit representation of the month',
    'n' => 'A newline character ("\n")',
    'o' => '',
    'p' => 'UPPER-CASE "AM" or "PM" based on the given time',
    'q' => '',
    'r' => 'Same as "%I:%M:%S %p"',
    's' => 'Unix Epoch Time timestamp',
    't' => 'A Tab character ("\t")',
    'u' => 'ISO-8601 numeric representation of the day of the week',
    'v' => '',
    'w' => 'Numeric representation of the day of the week',
    'x' => 'Preferred date representation based on locale, without the time',
    'y' => 'Two digit representation of the year',
    'z' => 'Either the time zone offset from UTC or the abbreviation (depends on operating system)',
    '%' => 'A literal percentage character ("%")',
);

// 結果
$strftimeValues = array();

// 書式を評価してエラーを抑制します
foreach ($strftimeFormats as $format => $description) {
    if (false !== ($value = @strftime("%{$format}"))) {
        $strftimeValues[$format] = $value;
    }
}

// 最長の値を探します
$maxValueLength = 2 + max(array_map('strlen', $strftimeValues));

// 既知の書式を表示します
foreach ($strftimeValues as $format => $value) {
    echo "Known format   : '{$format}' = ", str_pad("'{$value}'", $maxValueLength), " ( {$strftimeFormats[$format]} )\n";
}

// 未知の書式を表示します
foreach (array_diff_key($strftimeFormats, $strftimeValues) as $format => $description) {
    echo "Unknown format : '{$format}'   ", str_pad(' ', $maxValueLength), ($description ? " ( {$description} )" : ''), "\n";
}

?>

上の例の出力は、たとえば以下のようになります。

Known format   : 'A' = 'Friday'            ( A full textual representation of the day )
Known format   : 'B' = 'December'          ( Full month name, based on the locale )
Known format   : 'H' = '11'                ( Two digit representation of the hour in 24-hour format )
Known format   : 'I' = '11'                ( Two digit representation of the hour in 12-hour format )
Known format   : 'M' = '24'                ( Two digit representation of the minute )
Known format   : 'S' = '44'                ( Two digit representation of the second )
Known format   : 'U' = '48'                ( Week number of the given year, starting with the first Sunday as the first week )
Known format   : 'W' = '48'                ( A numeric representation of the week of the year, starting with the first Monday as the first week )
Known format   : 'X' = '11:24:44'          ( Preferred time representation based on locale, without the date )
Known format   : 'Y' = '2010'              ( Four digit representation for the year )
Known format   : 'Z' = 'GMT Standard Time' ( The time zone offset/abbreviation option NOT given by %z (depends on operating system) )
Known format   : 'a' = 'Fri'               ( An abbreviated textual representation of the day )
Known format   : 'b' = 'Dec'               ( Abbreviated month name, based on the locale )
Known format   : 'c' = '12/03/10 11:24:44' ( Preferred date and time stamp based on local )
Known format   : 'd' = '03'                ( Two-digit day of the month (with leading zeros) )
Known format   : 'j' = '337'               ( Day of the year, 3 digits with leading zeros )
Known format   : 'm' = '12'                ( Two digit representation of the month )
Known format   : 'p' = 'AM'                ( UPPER-CASE "AM" or "PM" based on the given time )
Known format   : 'w' = '5'                 ( Numeric representation of the day of the week )
Known format   : 'x' = '12/03/10'          ( Preferred date representation based on locale, without the time )
Known format   : 'y' = '10'                ( Two digit representation of the year )
Known format   : 'z' = 'GMT Standard Time' ( Either the time zone offset from UTC or the abbreviation (depends on operating system) )
Known format   : '%' = '%'                 ( A literal percentage character ("%") )
Unknown format : 'C'                       ( Two digit representation of the century (year divided by 100, truncated to an integer) )
Unknown format : 'D'                       ( Same as "%m/%d/%y" )
Unknown format : 'E'
Unknown format : 'F'                       ( Same as "%Y-%m-%d" )
Unknown format : 'G'                       ( The full four-digit version of %g )
Unknown format : 'J'
Unknown format : 'K'
Unknown format : 'L'
Unknown format : 'N'
Unknown format : 'O'
Unknown format : 'P'                       ( lower-case "am" or "pm" based on the given time )
Unknown format : 'Q'
Unknown format : 'R'                       ( Same as "%H:%M" )
Unknown format : 'T'                       ( Same as "%H:%M:%S" )
Unknown format : 'V'                       ( ISO-8601:1988 week number of the given year, starting with the first week of the year with at least 4 weekdays, with Monday being the start of the week )
Unknown format : 'e'                       ( Day of the month, with a space preceding single digits )
Unknown format : 'f'
Unknown format : 'g'                       ( Two digit representation of the year going by ISO-8601:1988 standards (see %V) )
Unknown format : 'h'                       ( Abbreviated month name, based on the locale (an alias of %b) )
Unknown format : 'i'
Unknown format : 'k'                       ( Hour in 24-hour format, with a space preceding single digits )
Unknown format : 'l'                       ( Hour in 12-hour format, with a space preceding single digits )
Unknown format : 'n'                       ( A newline character ("\n") )
Unknown format : 'o'
Unknown format : 'q'
Unknown format : 'r'                       ( Same as "%I:%M:%S %p" )
Unknown format : 's'                       ( Unix Epoch Time timestamp )
Unknown format : 't'                       ( A Tab character ("\t") )
Unknown format : 'u'                       ( ISO-8601 numeric representation of the day of the week )
Unknown format : 'v'

注意

注意: ISO 8601:1988 week numbers に基づいている %G と %V は、もしナンバリングシステムが完全に理解されていなければ期待とは違う結果をもたらします。このマニュアルの %V の例を参照ください。

参考

IntlDateFormatter::format
DateTimeInterface::format
» オンラインの strftime() 書式デザインツール
setlocale
mktime
strptime
gmstrftime
» Open Group による strftime の定義