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日 更新)

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

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。