PHPのdate_timezone_set()関数とは？使い方とサンプルコードを解説

date_timezone_set()関数は、DateTimeオブジェクトに対してタイムゾーンを設定するためのPHP組み込み関数です。処理が成功した場合はNULLを返し、失敗した場合はFALSEを返します。

基本構文

date_timezone_set(obj, timezone)

パラメータ

• obj − タイムゾーンを設定する対象となるDateTimeオブジェクトを指定します。

• timezone − 設定したいタイムゾーンを表すDateTimeZoneオブジェクトを指定します。通常はtimezone_open()関数で生成したものを使用します。

戻り値

date_timezone_set()関数は、タイムゾーンの設定に成功した場合はNULLを、失敗した場合はFALSEを返します。

使用例

以下は、date_timezone_set()関数を使ってDateTimeオブジェクトのタイムゾーンを変更するサンプルコードです。

<?php
   $dt = date_create("2018-09-30",timezone_open("America/Chicago"));
   date_timezone_set($dt,timezone_open("America/Antigua"));
   echo date_format($dt,"Y-m-d H:i:sP");
?>

実行結果

上記のコードを実行すると、次のような出力が得られます。

2018-09-30 01:00:00-04:00

解説

この例では、まずdate_create()関数で「2018-09-30」という日付を持つDateTimeオブジェクトを作成し、初期状態では「America/Chicago」（米国シカゴ）のタイムゾーンを設定しています。その後、date_timezone_set()関数を使ってタイムゾーンを「America/Antigua」（アンティグア・バーブーダ）に変更しています。

最後にdate_format()関数でフォーマットして出力すると、タイムゾーン変更後の日時とオフセット（-04:00）が表示されます。このように、date_timezone_set()関数を使えば、既存のDateTimeオブジェクトのタイムゾーンを後から簡単に変更することができます。