date_sub()
date_sub() — Alias of DateTime::sub().
Built-in function of PHP 8.5. The manual lists it as available in PHP 5 >= 5.3.0, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.
date_sub() is an alias of DateTime::sub(): same parameters, same return value.
Signature
date_sub(DateTime $object, DateInterval $interval): DateTime
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $object | DateTime | Procedural style only: A DateTime object returned by date_create(). The function modifies this object. |
| $interval | DateInterval | A DateInterval object |
Return value
Returns the modified DateTime object for method chaining.
Example
The PHP manual ships no example for date_sub(); the signature and the parameter table above are the contract.
All PHP 8.5 built-in functions
Reference card built from the PHP manual page date_sub() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.