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

date_date_set() 関数は、指定された DateTime オブジェクトに対して新しい日付を設定するための PHP の組み込み関数です。この関数を呼び出すと、対象のオブジェクトの日付が指定した値に更新され、時刻情報は元のまま保持されます。

構文

date_date_set ( object, year, month, day )

パラメータ

• object − 日付を設定する対象となる DateTime オブジェクト

• year − 設定する日付の年（例：2024）

• month − 設定する日付の月（1〜12）

• day − 設定する日付の日（1〜31）

戻り値

date_date_set() 関数は、処理が成功した場合に NULL を返し、失敗した場合には FALSE を返します。なお、PHP 5.3.0 以降では DateTime オブジェクトそのものが返されるため、メソッドチェーンにも対応しています。

使用例

以下に、date_date_set() 関数と、同じ役割を持つ setDate() メソッドを使用したサンプルコードを示します。

<?php
   $dateSrc = '2017-11-25 11:25 GMT'; 
   $dateTime = date_create($dateSrc);

   // date_date_set() を使って新しい日付を設定
   date_date_set($dateTime, 2000, 12, 12); 
   echo "New Formatted date is " . $dateTime->format("Y-m-d\TH:i:s\Z"); 
   echo "<br />"; 

   // setDate() メソッドを使った別の方法
   $dateTime = new DateTime($dateSrc); 
   $dateTime->setDate(1999, 10, 12); 
   echo "New Formatted date is " . $dateTime->format("Y-m-d\TH:i:s\Z");
?>

実行結果

New Formatted date is 2000-12-12T11:25:00Z
New Formatted date is 1999-10-12T11:25:00Z

解説

上記の例からわかるように、date_date_set() 関数や setDate() メソッドで日付を変更しても、時刻部分（11:25:00）は元の DateTime オブジェクトから引き継がれます。つまり、この関数は「日付のみ」を変更したい場合に便利です。時刻ごと変更したい場合は、date_time_set() 関数を併用するとよいでしょう。