Edit Report a Bug

DateTimeImmutable::modify

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

DateTimeImmutable::modify — Creates a new object with modified timestamp

Description

public DateTimeImmutable::modify(string $modifier): DateTimeImmutable|false

Creates a new DateTimeImmutable object with modified timestamp. The original object is not modified.

Parameters

modifier: A date/time string. Valid formats are explained in Date and Time Formats.

Return Values

Returns a new modified DateTimeImmutable object or false on failure.

Errors/Exceptions

If an invalid Date/Time string is passed, DateMalformedStringException is thrown. Previous to PHP 8.3, this was a warning.

Changelog

Version	Description
8.3.0	Now throws DateMalformedStringException if an invalid string is passed, instead of a warning.

Examples

Example #1 DateTimeImmutable::modify() example

Object-oriented style

<?php
$date = new DateTimeImmutable('2006-12-12');
$newDate = $date->modify('+1 day');
echo $newDate->format('Y-m-d');
?>

The above examples will output:

2006-12-13

Example #2 Beware when adding or subtracting months

<?php
$date = new DateTimeImmutable('2000-12-31');

$newDate1 = $date->modify('+1 month');
echo $newDate1->format('Y-m-d') . "\n";

$newDate2 = $newDate1->modify('+1 month');
echo $newDate2->format('Y-m-d') . "\n";
?>

The above example will output:

2001-01-31
2001-03-03

User Contributed Notes 1 note

down

dmytro dot sokil at gmail dot com ¶

6 years ago


To modify milliseconds and microseconds use next formats:

<?php
$a = new \DateTimeImmutable('2018-01-01 00:00:00.000'); 
$b = $a->modify('9 msec'); 
var_dump($b->format('Y-m-d H:i:s.u'));
?>

Returns string(26) "2018-01-01 00:00:00.009000"

<?php
$a = new \DateTimeImmutable('2018-01-01 00:00:00.000'); 
$b = $a->modify('9 usec'); 
var_dump($b->format('Y-m-d H:i:s.u'));
?>

Returns "2018-01-01 00:00:00.000009"

add a note