ワードプレスのcurrent_datetime関数の使用方法・解説

概要

current_datetime関数は、サイトのタームゾーン設定に合わせた現在の日時を取得するためのウィジェットです。この関数は、以下のような機能を実装する際によく使用されます。

1. データベースに日時を保存する際の基準時間の取得
2. ユーザーにリアルタイムな現在日時を表示するウィジェットの作成
3. 日時の計算、特に時間差の計算を行う際の基準を提供
4. 投稿やイベントの公開日時の比較
5. スケジュールされたイベントやタスクのチェック
6. ログイン時の最後のアクセス日時の取得
7. アーカイブやカレンダー表示のためのデータ取得
8. フィードの更新日時を表示する際の利用

構文

$current_datetime = current_datetime( $type, $gmt );

パラメータ

• $type (string) : 日時の形式を指定します。デフォルトは ‘datetime’ です。
• $gmt (bool) : GMTで取得する場合は true を指定します。デフォルトは false です。

戻り値

• DateTime オブジェクト : 現在の日時が返されます。

関連する関数

• current_time

使用可能なバージョン

• WordPress 4.9.8以降

コアファイルのパス

• wp-includes/functions.php

この関数のアクションでの使用可能性

アクション	使用状況
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme	〇
set_current_user
init	〇
register_sidebar
wp_loaded	〇
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

サンプルコード

1. 現在の日時を表示する基本的な例

   $current_datetime = current_datetime();
   echo $current_datetime->format('Y-m-d H:i:s');
   

   概要: 現在の日時を ‘Y-m-d H:i:s’ 形式で表示します。

2. GMT形式の日時を取得する例

   $gmt_datetime = current_datetime('mysql', true);
   echo $gmt_datetime->format('Y-m-d H:i:s');
   

   概要: GMT形式で現在の日時を ‘Y-m-d H:i:s’ 形式で表示します。

3. 特定のフォーマットで日時を表示する例

   $date = current_datetime();
   echo $date->format('l, F j, Y at g:i A');
   

   概要: 現在の日時を「曜日, 月 日, 年」のスタイルで表示します。

4. タイムゾーンを考慮した日時の取得

   date_default_timezone_set('Asia/Tokyo');
   $current_datetime = current_datetime();
   echo 'Current Tokyo time: ' . $current_datetime->format('Y-m-d H:i:s');
   

   概要: デフォルトのタイムゾーンを「Asia/Tokyo」に設定し、そのタイムゾーンにおける現在の日時を表示します。

5. 日時を取得して処理を行う例

   $now = current_datetime();
   if ($now->format('H') < 12) {
       echo 'Good morning!';
   } else {
       echo 'Good afternoon!';
   }
   

   概要: 現在の時間に応じて「おはよう」と「こんにちは」の挨拶を表示します。