DateTime::modify
PHP function
Edit on GitHub ✎
(PHP 5 >= 5.2.0, PHP 7, PHP 8)
Alters the timestamp
Description
Oop
DateTime::modify(string $modifier): DateTime
Procedural
date_modify(DateTime $object, string $modifier): DateTime|false
Alter the timestamp of a DateTime object by incrementing or decrementing in a format accepted by DateTimeImmutable::__construct().
Parameters
modifierParameter
Return Values
Returns DateTime on success. Procedural
Errors/Exceptions
Object Oriented API only: If an invalid Date/Time string is passed, DateMalformedStringException is thrown.
Changelog
| Version | Description |
|---|---|
| 8.4.0 | Now has a tentative return type of DateTime. Previously it was DateTime|false. |
| 8.3.0 | DateTime::modify now throws DateMalformedStringException if an invalid string is passed. Previously, it returned false, and a warning was emitted. date_modify() has not been changed. |
Examples
DateTime::modify() example
Oop
php
<?php
$date = new DateTime('2006-12-12');
$date->modify('+1 day');
echo $date->format('Y-m-d');The above example will output:
output
2006-12-13Procedural
php
<?php
$date = date_create('2006-12-12');
date_modify($date, '+1 day');
echo date_format($date, 'Y-m-d');The above example will output:
output
2006-12-13Beware when adding or subtracting months
php
<?php
$date = new DateTime('2000-12-31');
$date->modify('+1 month');
echo $date->format('Y-m-d') . "\n";
$date->modify('+1 month');
echo $date->format('Y-m-d') . "\n";The above example will output:
output
2001-01-31
2001-03-03All formats of Date and Time are supported
php
<?php
$date = new DateTime('2020-12-31');
$date->modify('July 1st, 2023');
echo $date->format('Y-m-d H:i') . "\n";
$date->modify('Monday next week');
echo $date->format('Y-m-d H:i') . "\n";
$date->modify('17:30');
echo $date->format('Y-m-d H:i') . "\n";The above example will output:
output
2023-07-01 00:00
2023-07-03 00:00
2023-07-03 17:30