【PHP8.x】DateTime::format()メソッドの使い方

Copy
1<?php
2
3// 現在の日時を取得
4$date = new DateTime();
5
6// フォーマットを指定して日付を文字列に変換
7$formattedDate = $date->format('Y-m-d H:i:s');
8
9// 結果を出力
10echo "現在の時刻: " . $formattedDate . PHP_EOL;
11
12// 別のフォーマットを試す
13$formattedDate2 = $date->format('D, M j, Y g:i a');
14
15// 結果を出力
16echo "別のフォーマット: " . $formattedDate2 . PHP_EOL;
17
18// タイムゾーンを指定して日付をフォーマット
19$tokyo = new DateTimeZone('Asia/Tokyo');
20$dateTokyo = new DateTime('now', $tokyo);
21
22//東京の現在時刻をフォーマット
23$formattedDateTokyo = $dateTokyo->format('Y年m月d日 H時i分s秒');
24
25// 結果を出力
26echo "東京の現在時刻: " . $formattedDateTokyo . PHP_EOL;

このPHPのサンプルコードは、DateTimeクラスのformatメソッドを使って、日付と時刻を指定された形式の文字列に変換する方法を示しています。

まず、new DateTime()で現在の日時を表すDateTimeオブジェクトを作成します。formatメソッドは、引数にフォーマット文字列を受け取り、それに基づいて日付を整形します。フォーマット文字列には、年、月、日、時間などを表すための特定の文字（例：Yは4桁の年、mは2桁の月）を使用します。

例えば、$date->format('Y-m-d H:i:s')は、日付をYYYY-MM-DD HH:MM:SSの形式で文字列に変換します。formatメソッドは、整形された日付文字列を返します。サンプルコードでは、複数の異なるフォーマットを指定して、日付の表示形式を柔軟に変更できることを示しています。

さらに、タイムゾーンを指定して日付をフォーマットする方法も示しています。DateTimeZoneクラスを使ってタイムゾーンを指定し、DateTimeオブジェクトを作成する際にそれを渡すことで、特定地域の現在時刻を取得し、フォーマットできます。例として、Asia/Tokyoタイムゾーンを指定して、東京の現在時刻をYYYY年MM月DD日 HH時ii分ss秒という形式で表示しています。

formatメソッドは、日付と時刻を様々な形式で表示する必要がある場合に非常に便利です。引数$formatに指定するフォーマット文字列によって、戻り値の文字列が変化します。

Copy
1<?php
2
3// 現在の日時を表す DateTime オブジェクトを作成します。
4$dateTime = new DateTime();
5
6// 'Y-m-d H:i:s' 形式で日時をフォーマットします。
7$formattedDateTime = $dateTime->format('Y-m-d H:i:s');
8
9// フォーマットされた日時を出力します。
10echo $formattedDateTime . PHP_EOL;
11
12// 異なる形式で日時をフォーマットします。
13$formattedDate = $dateTime->format('Y年m月d日');
14echo $formattedDate . PHP_EOL;
15
16// タイムゾーンを指定してフォーマット
17$tokyoDateTime = new DateTime('now', new DateTimeZone('Asia/Tokyo'));
18$formattedTokyoDateTime = $tokyoDateTime->format('Y-m-d H:i:s');
19echo $formattedTokyoDateTime . PHP_EOL;

PHPのDateTimeクラスのformatメソッドは、DateTimeオブジェクトが保持する日時を指定された形式の文字列に変換するために使用します。引数には、日付と時刻のフォーマットを指定する文字列 $format を渡します。このフォーマット文字列は、年、月、日、時間、分、秒などを表す特定の文字を含みます。例えば、'Y-m-d H:i:s' は、年-月-日 時:分:秒 の形式で日時を表示します。

サンプルコードでは、まず new DateTime() で現在の日時を表すDateTimeオブジェクトを作成しています。次に、format('Y-m-d H:i:s') を呼び出すことで、この日時を 'Y-m-d H:i:s' 形式の文字列に変換し、$formattedDateTime 変数に格納しています。echo でこのフォーマットされた日時を出力します。

別の例として、format('Y年m月d日') を使用すると、'Y年m月d日' という形式で日付を表示できます。このように、format メソッドに渡す文字列を変更することで、様々な形式で日時を表現できます。

さらに、タイムゾーンを指定してDateTimeオブジェクトを作成し、それをフォーマットすることも可能です。new DateTime('now', new DateTimeZone('Asia/Tokyo')) は、現在時刻をAsia/Tokyo（東京）のタイムゾーンでDateTimeオブジェクトとして生成します。その後、format('Y-m-d H:i:s') で東京の現在日時をフォーマットし、表示しています。

formatメソッドは文字列型 (string) の値を返し、これはフォーマットされた日時を表します。このメソッドを利用することで、アプリケーションの要件に合わせて柔軟に日時を表示できます。

Copy
1<?php
2
3/**
4 * DateTime::format メソッドの基本的な使用例を示す関数です。
5 * 日付と時刻のフォーマットに関する処理を理解するのに役立ちます。
6 */
7function displayFormattedDates(): void
8{
9    // 現在の日付と時刻を持つDateTimeオブジェクトを作成します。
10    // タイムゾーンが明示的に設定されていない場合、php.iniのdate.timezone設定が使用されます。
11    $now = new DateTime();
12
13    echo "--- 日付と時刻のフォーマット例 ---\n\n";
14
15    // 1. 標準的な国際日付形式 (例: 2023-10-27 15:30:45)
16    // 'Y': 4桁の年, 'm': 2桁の月, 'd': 2桁の日
17    // 'H': 24時間形式の時, 'i': 2桁の分, 's': 2桁の秒
18    echo "1. 国際日付形式 (YYYY-MM-DD HH:MM:SS): " . $now->format('Y-m-d H:i:s') . "\n";
19
20    // 2. 日本語の一般的な形式 (例: 2023年10月27日 15時30分45秒)
21    echo "2. 日本語形式 (YYYY年MM月DD日 HH時MM分SS秒): " . $now->format('Y年m月d日 H時i分s秒') . "\n";
22
23    // 3. 短い日付形式 (例: 10/27/2023)
24    // 'm': 2桁の月, 'd': 2桁の日, 'Y': 4桁の年
25    echo "3. 短い日付形式 (MM/DD/YYYY): " . $now->format('m/d/Y') . "\n";
26
27    // 4. 曜日と時刻を含む形式 (例: Fri, 15:30)
28    // 'D': 曜日の短縮形 (Mon, Tueなど), 'H': 24時間形式の時, 'i': 2桁の分
29    echo "4. 曜日と時刻 (D, HH:MM): " . $now->format('D, H:i') . "\n";
30
31    // 5. フルテキスト日付と時刻 (例: October 27, 2023, 3:30 pm)
32    // 'F': 月のフルテキスト (Januaryなど), 'j': 先頭にゼロが付かない日, 'Y': 4桁の年
33    // 'g': 12時間形式の時 (先頭にゼロが付かない), 'i': 2桁の分, 'a': am/pm (小文字)
34    echo "5. フルテキスト (Month Day, Year, HH:MM am/pm): " . $now->format('F j, Y, g:i a') . "\n";
35
36    // 6. Unixタイムスタンプ (1970年1月1日 00:00:00 UTCからの秒数)
37    // 'U': Unixタイムスタンプ
38    echo "6. Unixタイムスタンプ: " . $now->format('U') . "\n";
39
40    // 7. 完全なISO 8601形式 (例: 2023-10-27T15:30:45+09:00)
41    // DateTime::ATOM 定数は 'Y-m-d\TH:i:sP' と同等です。
42    // '\T' のようにバックスラッシュでエスケープすることで、リテラルの 'T' を出力できます。
43    // 'P': タイムゾーンのオフセット (+HH:MM または -HH:MM)
44    echo "7. 完全なISO 8601形式: " . $now->format(DateTime::ATOM) . "\n";
45}
46
47// 関数を実行して、フォーマットされた日付を出力します。
48displayFormattedDates();

PHPのDateTime::formatメソッドは、DateTimeオブジェクトに格納されている日付と時刻の情報を、指定された書式で文字列として出力するために使用される非常に便利な機能です。システムエンジニアを目指す方にとって、日付や時刻の表示形式を自在に制御する基本的なスキルの一つとなります。

このメソッドは、引数としてstring $formatを受け取ります。この$formatには、年、月、日、時、分、秒、曜日などを表す特別な「書式指定文字」を組み合わせた文字列を指定します。例えば、「Y」は4桁の年を、「m」は2桁の月を、「d」は2桁の日を表し、「H」は24時間形式の時を表します。これらの文字を組み合わせて「Y-m-d H:i:s」のように指定することで、"2023-10-27 15:30:45"のような国際的な形式で日付と時刻を表示できます。また、「Y年m月d日 H時i分s秒」のように日本語の文字と組み合わせて、より自然な形式で出力することも可能です。

メソッドの戻り値は、指定された書式に従ってフォーマットされた日付と時刻の文字列です。サンプルコードでは、まず現在の時刻をDateTimeオブジェクトとして取得し、このformatメソッドを使って多様な形式で日付と時刻を出力しています。国際標準形式、日本語形式、短い日付形式、曜日を含む形式、さらにはUnixタイムスタンプやISO 8601形式など、さまざまな出力例が示されており、書式指定文字の柔軟な使い方を理解するのに役立ちます。DateTime::ATOMのような定数を利用すると、国際的な標準形式を簡単に指定することもできます。日付や時刻の表示をカスタマイズする際に、このメソッドは不可欠なツールとなります。

Copy
1<?php
2
3/**
4 * 現在の日時を特定のフォーマットで表示するサンプル。
5 * DateTime::format() メソッドは、日付/時刻オブジェクトを指定された形式の文字列に変換します。
6 */
7function showFormattedDateTime(): void
8{
9    // 現在の日時を表すDateTimeオブジェクトを作成
10    $now = new DateTime();
11
12    // 'Y-m-d H:i:s' フォーマットで日時を出力
13    // Y: 年 (4桁), m: 月 (2桁), d: 日 (2桁)
14    // H: 時 (24時間形式, 2桁), i: 分 (2桁), s: 秒 (2桁)
15    $formattedDateTime = $now->format('Y-m-d H:i:s');
16    echo "現在の年月日と時間: " . $formattedDateTime . PHP_EOL;
17
18    // 別のフォーマットで出力（例: 曜日、月名、日、年）
19    // D: 曜日 (短縮形), M: 月 (短縮形), j: 日 (先頭ゼロなし), Y: 年 (4桁)
20    $anotherFormat = $now->format('D, M jS, Y');
21    echo "別のフォーマット: " . $anotherFormat . PHP_EOL;
22
23    // 時間だけを出力（午前/午後付き）
24    // h: 時 (12時間形式, 2桁), i: 分 (2桁), A: 午前/午後 (大文字)
25    $timeOnly = $now->format('h:i A');
26    echo "現在の時間のみ: " . $timeOnly . PHP_EOL;
27}
28
29// 関数を実行
30showFormattedDateTime();
31
32?>

PHPのDateTime::format()メソッドは、DateTimeオブジェクトが保持する日付や時刻の情報を、指定された書式で整形された文字列に変換する際に利用します。引数string $formatには、年、月、日、時、分、秒といった日時要素に対応する特別な書式文字を組み合わせた文字列を指定します。これにより、指定書式に従って整形されたstring型の文字列が戻り値として返されます。

サンプルコードでは、まず現在の時刻を表すDateTimeオブジェクトを作成し、このオブジェクトに対してformat()メソッドを使って複数回日時を出力しています。最初の例では'Y-m-d H:i:s'という書式を指定し、「現在の年月日と時間」を「2023-10-27 15:30:00」のように表示しており、年、月、日、時、分、秒がそれぞれ整形されています。

また、'D, M jS, Y'という書式で曜日や月名を含む「別のフォーマット」を出力し、さらに'h:i A'で午前/午後付きの「現在の時間のみ」を表示しています。このようにDateTime::format()メソッドは、日付や時刻の表示形式を柔軟に制御できるため、ログ出力やユーザーインターフェースなど、様々なシステム開発の場面で非常に役立つ機能です。