概要
date_i18n関数は、日付／時刻を書式化した文字列を取得するための関数です。この関数は、WordPressが国際化対応で日付と時刻を適切に表示するために設計されています。主に以下のような場面で使われます：
- 投稿やコメントのタイムスタンプを表示する際
- カスタム投稿タイプの作成時に日付フィールドを表示する際
- ウィジェットで現在の日付や時刻を表示する際
- テーマのヘッダーやフッターで日付を表示する際
- 宣伝やお知らせの更新日を表示する際
- フォームの送信日時を表示する際
- イベントカレンダーやスケジュールの表示時
- ログやデータの表示時にタイムスタンプを追加する際
構文
string date_i18n( string $date_format, int|null $timestamp = null, bool $gmt = false )
パラメータ
$date_format(string): 出力したい日付の書式。$timestamp(int|null): 書式化するUnixタイムスタンプ。省略した場合は現在の日時に基づいた値が使用される。$gmt(bool):真の場合、GMTタイムゾーンでの日付を取得。
戻り値
- (string): 指定された書式で整形された日付／時刻を返す。
関連する関数
この関数を使用可能なバージョン
- ワードプレスバージョン 2.0.0 以降で使用可能。
コアファイルのパス
wp-includes/functions.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head | 〇 |
サンプルコード
サンプル1: 現在の日付を表示する
echo date_i18n('Y年m月d日 H:i:s'); // 現在の日付を「YYYY年MM月DD日 HH:mm:ss」形式で表示
このコードは、現在の日時を日本語形式で表示します。
サンプル2: 指定したタイムスタンプの日付を表示する
$timestamp = strtotime('2023-03-15 10:00:00');
echo date_i18n('Y年m月d日', $timestamp); // 2023年03月15日を表示
指定した日時のタイムスタンプから日付を整形して表示します。
サンプル3: GMTで日付を表示する
echo date_i18n('Y-m-d H:i:s', null, true); // GMTの現在の日付を表示
このコードは、GMTタイムゾーンでの日付を表示します。
サンプル4: カスタムフォーマットの日付を使用する
echo date_i18n('l, F j, Y'); // 曜日、月、日の形式で表示
指定したカスタムフォーマットに基づいて日付を表示します。
サンプル5: 投稿の更新日時を表示
the_modified_date('Y年m月d日'); // 投稿の更新日を「YYYY年MM月DD日」形式で表示
このコードは、特定の投稿の最終更新日を表示します。