PHP 8.0.24 Released!

DateTimeImmutable::modify

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

DateTimeImmutable::modifyCreates 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.

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

See Also

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top