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



お勧め

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

ブロックエディターをちょっとだけカスタマイズしてみる(2021年11月3日 更新)

ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか(自分好みに)調整してみた。

Login rebuilder 2.3.0の新機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 更新)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。