date_i18n() の使い方|説明・引数・注意点

説明

date_i18n() は、日付を、サイトの言語・タイムゾーンに合わせて書式化する関数です。

基本構文

date_i18n( string $format, int|bool $timestamp_with_offset = false, bool $gmt = false ): string

引数

  • $format:日付の書式
  • $timestamp_with_offset:タイムスタンプ
  • $gmt:GMTとして扱うか

戻り値

書式化した日付。

使い方(サンプル)

echo esc_html( date_i18n( 'Y/m/d', strtotime( '2026-10-03' ) ) );

注意点

  • WordPress 5.3 以降は wp_date() が推奨されます。

実務での使いどころ

  • 日付を、翻訳(日本語の曜日・月名)つきで、整形するとき。
  • 従来のテーマで、使われている、日付の整形を、理解するとき。

よくあるミスと対処

  • 新しいコードでも、これを使っている。WordPress 5.3以降は、wp_date() が推奨される。
  • 第2引数に渡す、タイムスタンプの意味(タイムゾーンのずれを含む値)を、取り違える。

NG例

echo date_i18n( 'Y年n月j日', time() ); // タイムゾーンの扱いが、分かりにくい

OK例

echo esc_html( wp_date( 'Y年n月j日' ) );

使い分け早見表

関数 特徴
date_i18n() 翻訳つきで、整形する(従来の関数)
wp_date() サイトのタイムゾーンで整形する(推奨)
current_time() 現在の日時を、取得する

関連項目

wp_date()、current_time()

公式リファレンス:date_i18n() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました