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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。

Login rebuilderのログ表示機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 更新)

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。