概要
get_gmt_from_date関数は、指定した日時をUTC（協定世界時）に変換するために使用されます。この関数は、WordPressサイトの日時をUTCの日時に変換する際に非常に役立ちます。以下に、この関数がよく使用されるシナリオを示します。
- 日時をフィルタリングする際にUTC形式が必要な場合
- データベースに日時をUTCで保存する場合
- REST APIから返される日時をUTCに変換する場合
- 外部サービスと連携する際にUTCでの日時が求められる場合
- 複数のタイムゾーンを扱う場合に標準化するため
- イベントカレンダーのイベント日時をUTCで表示する場合
- 投稿の公開日時をUTCで処理する場合
- ユーザーが異なるタイムゾーンにいる場合の調整に使用する場合
構文
get_gmt_from_date( string $date, bool $include_time = false )
パラメータ
$date(string): 変換したい日時を指定します。これは'Y-m-d H:i:s'形式である必要があります。$include_time(bool, optional): 時間を含めるかどうかを指定します。デフォルトはfalseです。
戻り値
- 変換されたUTC形式の日時文字列が返されます。
関連する関数
バージョン情報
get_gmt_from_date関数は、WordPress 2.1以降で使用可能です。
コアファイルのパス
wp-includes/general-template.php
サンプルコード
サンプルコード1
$date = '2023-10-10 15:00:00';
$utc_date = get_gmt_from_date($date);
echo $utc_date; // UTC形式の日時を表示
このサンプルは、指定したローカル日時をUTC形式に変換し、結果を出力します。
サンプルコード2
$date = '2023-10-10 15:00:00';
$utc_date = get_gmt_from_date($date, true);
echo $utc_date; // 時間を含むUTC形式の日時を表示
このサンプルは、時間を含むローカル日時をUTCに変換し、結果を出力します。
サンプルコード3
$friend_date = '2023-10-10 10:00:00';
$utc_format = get_gmt_from_date($friend_date);
if ($utc_format) {
echo "友人の日時（UTC）: " . $utc_format;
}
このサンプルは、友人の日時をUTC形式に変換し、結果を表示します。
サンプルコード4
$post_date = '2023-10-10 12:00:00';
echo "投稿のUTC日時: " . get_gmt_from_date($post_date);
このサンプルは、投稿の日時をUTC形式に変換して表示するものです。
サンプルコード5
$event_date = '2023-10-10 18:00:00';
$utc_event_date = get_gmt_from_date($event_date);
update_post_meta($post_id, 'event_date_utc', $utc_event_date);
このサンプルは、イベントの日時をUTC形式に変換し、その結果を投稿メタデータに保存します。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
非推奨または削除されたバージョン
特に非推奨や削除されたバージョンはありません。