Edit Report a Bug

DateTimeImmutable::modify

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

DateTimeImmutable::modify — Создаёт новый объект с изменённой временной меткой

Описание

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

Создаёт новый объект DateTimeImmutable с изменённой временной меткой. Первоначальный объект не изменяется.

Список параметров

modifier: Строка даты/времени. Объяснение корректных форматов дано в разделе Форматы даты и времени.

Возвращаемые значения

Возвращает новый модифицированный объект DateTimeImmutable или false в случае возникновения ошибки.

Ошибки

Если передана строка с недопустимой датой/временем, выбрасывается исключение DateMalformedStringException. До PHP 8.3 появлялось предупреждение.

Список изменений

Версия	Описание
8.3.0	Теперь вместо предупреждения выбрасывается исключение DateMalformedStringException, если передана недопустимая строка.

Примеры

Пример #1 Пример использования DateTimeImmutable::modify()

Объектно-ориентированный стиль

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

Результат выполнения приведённых примеров:

2006-12-13

Пример #2 Будьте осторожны при сложении или вычитании месяцев

<?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";
?>

Результат выполнения приведённого примера:

2001-01-31
2001-03-03

Смотрите также

DateTimeImmutable::add() - Возвращает новый объект с добавленным количеством дней, месяцев, лет, часов, минут и секунд
DateTimeImmutable::sub() - Вычитает переданное количество дней, месяцев, лет, часов, минут и секунд
DateTimeImmutable::setDate() - Устанавливает дату
DateTimeImmutable::setISODate() - Устанавливает дату в формате ISO
DateTimeImmutable::setTime() - Устанавливает время
DateTimeImmutable::setTimestamp() - Устанавливает дату и время на основе метки времени Unix

add a note

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