DateTime::sub

date_sub

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

DateTime::sub -- date_sub — 年月日時分秒の値を DateTime オブジェクトから引く

説明

オブジェクト指向型

public DateTime::sub(DateInterval $interval): DateTime

手続き型

date_sub(DateTime $object, DateInterval $interval): DateTime

指定した DateInterval オブジェクトを引くことで、指定した DateTime オブジェクトを変更します。

DateTimeImmutable::sub() に似ていますが、 DateTime を使って動作します。

手続き型のバージョンは、 DateTime オブジェクトを最初の引数に取ります。

パラメータ

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

戻り値

メソッドチェインに使う、変更された DateTime オブジェクトを返します。

エラー / 例外

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

変更履歴

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

参考

DateTimeImmutable::sub() - 年月日時分秒の値を引く