date_format

関数の概要

PHPの date_format 関数は、DateTime オブジェクトの日付や時刻を、指定したフォーマットの文字列に変換して表示するために使われます。これにより、日付や時刻を見やすい形式や必要な形式で出力できるようになります。WordPressなどの開発で日時を扱う際に非常に便利な関数です。

パラメータの説明

  • $object : DateTime オブジェクト。日時情報を保持したオブジェクトを指定します。
  • $format : フォーマット文字列。出力したい日時のフォーマットを指定します。フォーマットの詳細はPHP公式マニュアルを参照してください。

戻り値

指定したフォーマットに従った日時の文字列を返します。もし引数が無効な場合は false を返します。

使用例

基本的な使い方

$date = new DateTime('2024-06-01 15:30:00');
echo date_format($date, 'Y-m-d H:i:s'); // 2024-06-01 15:30:00

新しい DateTime オブジェクトを作成し、date_format で「年-月-日 時:分:秒」の形式で表示しています。

曜日や文字列を含めたフォーマット

$date = new DateTime();
echo date_format($date, 'Y年m月d日 (D) H時i分'); // 例: 2024年06月01日 (Sat) 15時30分

曜日の省略形や日本語の文字を含めて日時を柔軟にフォーマットできます。

タイムゾーンを変えて表示する

$date = new DateTime('now', new DateTimeZone('Asia/Tokyo'));
echo date_format($date, 'Y-m-d H:i:s T'); // 例: 2024-06-01 15:30:00 JST

タイムゾーンを指定したDateTimeオブジェクトから日時をフォーマットして表示できます。タイムゾーン名も出力可能です。

関連する関数

  • DateTime::format() – date_formatと同じく日時のフォーマットを行うメソッド
  • date() – タイムスタンプをフォーマットして表示する関数
  • DateTime::createFromFormat() – 指定したフォーマットから日時の DateTime オブジェクトを生成

まとめ

date_format は DateTime オブジェクトの日時を任意のフォーマットで表示したいときに使う便利な関数です。正しいフォーマット文字列を設定すれば、見やすい形式や要件にあった形式で日時を簡単に出力できます。WordPressなどPHPで日時操作を行う際、柔軟な表示のためにぜひ活用しましょう。

スポンサーリンク