DateTimeImmutable::add

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

DateTimeImmutable::add 年月日時分秒の値を加え、新しいオブジェクトを返す

説明

public DateTimeImmutable::add(DateInterval $interval): DateTimeImmutable

指定された DateInterval オブジェクトを、 指定された DateTime オブジェクトに加え、 新しい状態を表す DateTimeImmutable オブジェクトを返します。

パラメータ

object

手続き型のみ: date_create() が返す DateTime オブジェクト。 この関数は、このオブジェクトを変更します。

interval

DateInterval オブジェクト。

戻り値

新しく変更された DateTimeImmutable オブジェクトを返します。失敗した場合に false を返します.

例1 DateTimeImmutable::add() の例

オブジェクト指向型

<?php
$date 
= new DateTimeImmutable('2000-01-01');
$newDate $date->add(new DateInterval('P10D'));
echo 
$newDate->format('Y-m-d') . "\n";
?>

例2 DateTimeImmutable::add() の高度な例

<?php
$date 
= new DateTimeImmutable('2000-01-01');
$newDate $date->add(new DateInterval('PT10H30S'));
echo 
$newDate->format('Y-m-d H:i:s') . "\n";

$date = new DateTimeImmutable('2000-01-01');
$newDate $date->add(new DateInterval('P7Y5M4DT4H3M2S'));
echo 
$newDate->format('Y-m-d H:i:s') . "\n";
?>

上の例の出力は以下となります。

2000-01-01 10:00:30
2007-06-05 04:03:02

例3 月を足す場合は注意

<?php
$date 
= new DateTimeImmutable('2000-12-31');
$interval = new DateInterval('P1M');

$newDate1 $date->add($interval);
echo 
$newDate1->format('Y-m-d') . "\n";

$newDate2 $newDate1->add($interval);
echo 
$newDate2->format('Y-m-d') . "\n";
?>

上の例の出力は以下となります。

2001-01-31
2001-03-03

参考

関連キーワード:  オブジェクト, DateTimeImmutable, 年月, 分秒, 日時, , 変更, DateInterval, DateTime, interval