DateTime::diff

PHP 5 >= 5.3.0, PHP 7, PHP 8
DateTime::diff - Returns the difference between two DateTime objects
Manual
Code Examples

DateTime::diff( DateTimeInterface$targetObject, [bool$absolute = false] ): public DateInterval
public DateIntervalDateTimeImmutable::diff DateTimeInterfacetargetObject boolabsolutefalse

Parameters

datetime

The date to compare to.

absolute

Should the interval be forced to be positive?

Return Values

The DateInterval object represents the difference between the two dates or false on failure.

The return value more specifically represents the interval to apply to the original object ($this or $originObject) to arrive at the $targetObject. This process is not always reversible.

Related Functions

  • DateInterval::format - Formats the interval
  • DateTime::add - Adds an amount of days, months, years, hours, minutes and seconds to a DateTime object
  • DateTime::sub - Subtracts an amount of days, months, years, hours, minutes and seconds from a DateTime object

Example of DateTime::diff

Show all examples for DateTime::diff

Edit/Test in Sandbox
PHP Version:


Function DateTime::diff:

Date and Time Functions

Most used PHP functions