wp_date

説明

string | false wp_date( string $format [ , int $timestamp = null [ , DateTimeZone $timezone = null ] ] )
日付/時刻を書式化した文字列を取得する。

パラメータ

  • $format
    日付フォーマットを指定。
  • $timestamp
    Unixタイムスタンプ(秒)を指定(省略時はnull)。
  • $timezone
    タイムゾーン情報(DateTimeZoneオブジェクト)を指定(省略時はnull)。

返り値

パラメータ$timestampが有効な場合はその日時を示す文字列を返す。無効な場合はfalseを返す。


注意

date_i18n関数を置き換える目的で追加された関数で、機能は似ているが差異もある。

パラメータ$timestampが省略された場合は、現在の日時が適用される。なお数字(is_numeric)以外の場合は、フィルターを実行せずすぐにfalseを返す。

パラメータ$timezoneが省略された場合は、サイトに設定されているタイムゾーンが適用される。


使用例

  • サイトのタイムゾーンを適用した現時刻の文字列を取得する。
    <?php $datetime = wp_date( 'Y-m-d H:i' ); ?>
  • サイトのタイムゾーンを適用したパラメータ$timeの文字列を取得する。
    <?php $datetime = wp_date( 'Y-m-d H:i', $time ); ?>
  • パリのタイムゾーンを適用した現時刻の文字列を取得する。
    <?php $datetime = wp_date( 'Y-m-d H:i', null, new DateTimeZone( 'Europe/Paris' ) ); ?>

フィルター

[5.3.0]日時の文字列を返す前に'wp_date'フィルターを呼び出す。パラメータ$dateには日時を示す文字列が、$format$timestampには本関数が受け取った値が、$timezoneには適用されたタイムゾーン情報が格納されている。
$date = apply_filters( 'wp_date', $date, $format, $timestamp, $timezone );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/functions.php

最終更新 : 2023年12月12日 12:03



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。