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

最終更新 : 2019年11月14日 10:49



お勧め

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を(2013年11月6日 更新)

WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。