概要
wp_date 関数は、WordPress の日付／時刻を書式化した文字列を取得するために使用されます。この関数は、カスタムテーマやプラグインの開発時に、日付や時刻を整形してユーザーに表示したい場合に頻繁に利用されます。具体的には、以下のような機能の実装時に活用されることが多いです。
- 投稿の日付を表示
- コメントの日付を表示
- 繰り返しイベントの日付を表示
- 日時のカスタムフィールドを表示
- ウィジェットの日付情報を表示
- カスタムループの日付をフォーマット
- ショートコード内の日付情報を表示
- REST API からのレスポンスで日付をフォーマット
構文
wp_date( $date_format, $timestamp = null, $timezone = null );
パラメータ
$date_format(string) : 表示したい日付のフォーマット。PHP のdate()関数と同じ形式。$timestamp(int|null) : 指定したい日時のタイムスタンプ。省略した場合は現在の日時が使用される。$timezone(string|null) : 日付を表示する際のタイムゾーン。省略した場合は WordPress の設定に基づくタイムゾーンが使用される。
戻り値
- (string) 指定したフォーマットで整形された日付文字列。
関連する関数
使用可能なバージョン
- WordPress 5.3.0 以降
コアファイルのパス
wp-includes/general-template.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 wp_date( 'Y年m月d日', get_the_date( 'U' ) );
このコードは、現在の投稿の作成日を「YYYY年MM月DD日」形式で表示します。
サンプル2: カスタムフォーマットで現在の日付を表示
// 現在の日付をカスタムフォーマットで表示
echo wp_date( 'l, F j, Y' );
このコードは、今日の日付を「曜日, 月 日, 年」の形式で表示します。
サンプル3: タイムスタンプを指定した表示
// 特定のタイムスタンプの日付を表示
$timestamp = strtotime( '2023-01-01 12:00:00' );
echo wp_date( 'Y/m/d H:i', $timestamp );
このコードは、指定したタイムスタンプの日時を「YYYY/MM/DD HH:MM」形式で表示します。
サンプル4: タイムゾーンを指定して表示
// タイムゾーンを指定して日付を表示
echo wp_date( 'Y-m-d H:i:s', null, 'America/New_York' );
このコードは、ニューヨークのタイムゾーンで現在の日付と時刻を表示します。
サンプル5: 投稿の更新日を表示
// 投稿の更新日を表示
echo wp_date( 'Y年m月d日 H:i', get_the_modified_time( 'U' ) );
このコードは、現在の投稿の更新日を「YYYY年MM月DD日 HH:MM」形式で表示します。
出典: すべてのサンプルコードは著作権フリーのものであり、WordPress の公式ドキュメントに基づいています。詳細については公式ドキュメントをご覧ください。