DateTime::modify

date_modify

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

DateTime::modify -- date_modify — 修改日期时间对象的值

说明

面向对象风格

public DateTime::modify(string $modifier): DateTime

过程化风格

date_modify(DateTime $object, string $modifier): DateTime|false

通过 DateTimeImmutable::__construct() 能够接受的格式，对 Datetime 对象的时间戳进行修改（自增或者自减）。

参数

object: 仅过程化风格：由 date_create() 返回的 DateTime 类型的对象。此函数会修改这个对象。
modifier: 日期/时间字符串。正确格式的说明详见日期与时间格式。

返回值

成功时返回 DateTime。过程化风格在失败时返回 false。

错误／异常

仅限于面向对象的 API：如果传递了无效的日期/时间字符串，将抛出 DateMalformedStringException。

更新日志

版本	说明
8.3.0	如果传递了无效的字符串，DateTime::modify() 现在将抛出 DateMalformedStringException 。之前返回 `false` 并且发出警告。date_modify() 尚未更改。

示例

示例 #1 DateTime::modify() 示例

面向对象风格

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

以上示例会输出：

2006-12-13

过程化风格

<?php
$date = date_create('2006-12-12');
date_modify($date, '+1 day');
echo date_format($date, 'Y-m-d');

以上示例会输出：

2006-12-13

示例 #2 增加或者减少月份的时候需要当心

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

以上示例会输出：

2001-01-31
2001-03-03

示例 #3 支持所有日期和时间格式

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

以上示例会输出：

2023-07-01 00:00
2023-07-03 00:00
2023-07-03 17:30

参见

strtotime() - 将任何英文文本日期时间描述解析为 Unix 时间戳
DateTimeImmutable::modify() - Creates a new object with modified timestamp
DateTime::add() - 修改 DateTime 对象，增加天、月、年、小时、分钟以及秒的数量。
DateTime::sub() - 对 DateTime 对象减去一定量的日、月、年、小时、分钟和秒。
DateTime::setDate() - 设置日期
DateTime::setISODate() - 设置 ISO 日期
DateTime::setTime() - 设置时间
DateTime::setTimestamp() - 以 Unix 时间戳的方式设置日期和时间