PHP マニュアル: 年月日時分秒の値を引く

説明

public DateTimeImmutable DateTimeImmutable::sub(DateInterval $interval)

指定した DateInterval オブジェクトを、指定した DateTimeImmutable オブジェクトから引き、新しい DateTimeImmutable オブジェクトを返します。

パラメータ

interval: DateInterval オブジェクト。

戻り値

変更されたデータを持つ、新しい DateTimeImmutable オブジェクトを返します。

エラー / 例外

サポートされていない操作を試みた場合、 DateInvalidOperationExceptionがスローされます。サポートされていない操作の例としては、 next weekday のような相対時刻を表現する DateInterval を使った場合が挙げられます。

変更履歴

バージョン	説明
8.3.0	サポートされていない操作を試みた場合に、警告を発生させるのではなく、 DateInvalidOperationException がスローされるようになりました。

例

例1 DateTimeImmutable::sub の例

オブジェクト指向型

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

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

2000-01-10

例2 DateTimeImmutable::sub の別な例

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

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

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

2000-01-19 13:59:30
1992-08-15 19:56:58

例3 月を減算する際は注意

<?php
$date = new DateTimeImmutable('2001-04-30');
$interval = new DateInterval('P1M');

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

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

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

2001-03-30
2001-03-02

参考

DateTimeImmutable::add
DateTimeImmutable::diff
DateTimeImmutable::modify