Home/ Manual/ datetime / datetime/ DateTime::sub

DateTime::sub

PHP function Edit on GitHub ✎

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

Subtracts an amount of days, months, years, hours, minutes and seconds from a DateTime object

Description

Oop

DateTime::sub(DateInterval $interval): DateTime

Procedural

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

Modifies the specified DateTime object, by subtracting the specified DateInterval object.

Like DateTimeImmutable::sub but works with DateTime.

The procedural version takes the DateTime object as its first argument.

Parameters

interval: A DateInterval object

Return Values

Modifiedobject

Errors/Exceptions

Object Oriented API only: If an unsupported operation is attempted, such as using a DateInterval object representing relative time specifications such as next weekday, a DateInvalidOperationException is thrown.

Changelog

Version	Description
8.3.0	Now throws a `DateInvalidOperationException` with `DateTime::sub`, instead of a warning when an unsupported operation is attempted. `date_sub()` has not been changed.