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

PHPのdate_time_set()関数は、DateTimeオブジェクトに対して時刻（時・分・秒）を設定するための関数です。処理が成功した場合はDateTimeオブジェクトを返し、失敗した場合はFALSEを返します。

なお、この関数はDateTime::setTime()メソッドの手続き型（関数型）エイリアスにあたります。

構文

date_time_set(obj, hour, minute, second)

パラメータ

• obj − 時刻を設定する対象となるDateTimeオブジェクト

• hour − 設定する「時」の値

• minute − 設定する「分」の値

• second − 設定する「秒」の値（省略可能、デフォルトは0）

戻り値

date_time_set()関数は、処理が成功した場合にはDateTimeオブジェクトを返します。失敗した場合はFALSEを返します。

使用例

まずは基本的な使い方を見てみましょう。

<?php
   $dt = date_create("2018-09-05");
   date_time_set($dt,8,15);
   echo date_format($dt,"Y-m-d H:i:s");
?>

出力結果

上記のコードを実行すると、以下のように出力されます。

2018-09-05 08:15:00

別の使用例

続いて、別の日付と時刻を設定する例です。

<?php
   $dt = date_create("2017-08-08");
   date_time_set($dt,13,24);
   echo date_format($dt,"Y-m-d H:i:s");
?>

出力結果

実行結果は以下の通りです。

2017-08-08 13:24:00

このように、date_time_set()関数を使えば、既存のDateTimeオブジェクトの日付はそのままに、時刻だけを自由に変更できます。日付と時刻を個別に操作したい場面で非常に便利な関数です。