PHPのdate_offset_get()関数の使い方を徹底解説

PHPのdate_offset_get()関数は、指定した日時のタイムゾーンにおけるサマータイム（DST：Daylight Saving Time）のオフセットを取得するための関数です。処理が成功した場合はDSTオフセットを秒単位で返し、失敗した場合はFALSEを返します。

この関数を使うことで、特定の日時がどのタイムゾーンで、UTC（協定世界時）からどれだけの時差を持つのかを簡単に確認できます。

構文

date_offset_get(object)

パラメータ

• object − オフセットを取得したいDateTimeオブジェクトを指定します。

戻り値

date_offset_get()関数は、成功した場合にDSTオフセットを秒単位で返します。失敗した場合はFALSEを返します。

使用例1

以下は、date_offset_get()関数の基本的な使用例です。

<?php
   $dateSrc = '2017-09-23 12:50 GMT';
   $dateTime = date_create( $dateSrc);
   $retval = date_offset_get( $dateTime);
   echo "Returned value is $retval";
   echo "<br />";
   # 2つ目の方法としてDateTimeクラスのgetOffset()メソッドを使用
   $dateTime = new DateTime($dateSrc);
   $retval = $dateTime->getOffset();
   echo "Returned value is $retval";
?>

出力結果

Returned value is 0
Returned value is 0

この例では、日時がGMT（グリニッジ標準時）で指定されているため、UTCとのオフセットは0秒となっています。また、date_offset_get()関数と、DateTimeクラスのgetOffset()メソッドのどちらを使っても同じ結果が得られることがわかります。

使用例2

次に、タイムゾーンを明示的に指定した例を見てみましょう。

<?php
   $res = date_create("2018-08-20", timezone_open("Europe/Oslo"));
   echo date_offset_get($res) . "    seconds.<br />";
?>

出力結果

7200 seconds

この例では、タイムゾーンとして「Europe/Oslo」（ノルウェーのオスロ）を指定しています。8月20日はサマータイムが適用されている期間のため、UTCとのオフセットは7200秒（2時間）として返されます。

まとめ

date_offset_get()関数は、DateTimeオブジェクトのタイムゾーンオフセットを秒単位で取得できる便利な関数です。サマータイムが導入されている地域では、日付によってオフセットが変化するため、正確な時刻計算を行う際に役立ちます。なお、オブジェクト指向スタイルではDateTimeクラスのgetOffset()メソッドを使うことで、同じ機能を実現できます。