[函数]date_diff()函数—用法及示例

PHP函数: date_diff()

适用版本: PHP 5.3.0+

用法:

date_diff() 函数用于计算两个日期之间的差值，并返回一个 DateInterval 对象。

语法:

date_diff ( DateTimeInterface $start , DateTimeInterface $end [, bool $absolute = false ] ) : DateInterval|false

参数说明:

• $start: 起始日期，必须是一个实现了 DateTimeInterface 接口的对象，比如 DateTime 对象。
• $end: 结束日期，必须是一个实现了 DateTimeInterface 接口的对象。
• $absolute (可选): 如果为 true，则返回的差值的绝对值。默认为 false。

返回值:

该函数返回一个 DateInterval 对象，表示起始日期（$start）和结束日期（$end）之间的差值。如果发生错误，则返回 false。

示例:

$start = new DateTime('2022-01-01');
$end = new DateTime('2022-12-31');
$diff = date_diff($start, $end);

echo $diff->format('%R%a 天'); // 输出: +364 天

在上面的示例中，我们创建了一个起始日期为 2022-01-01，结束日期为 2022-12-31 的 DateTime 对象。然后，我们使用 date_diff() 函数来计算这两个日期之间的差值，并将结果存储在 $diff 变量中。最后，我们使用 DateInterval 对象的 format() 方法来格式化差值，并输出结果。

注意:

• DateInterval 对象的 format() 方法用于格式化日期间隔，并接受一个格式化字符串作为参数。在上面的示例中，我们使用 '%R%a 天' 来格式化差值，其中 '%R' 代表正负号，'%a' 代表日期间隔的总天数。

• 如果发生错误（例如，无效的日期），则 date_diff() 函数将返回 false。因此，在使用返回值之前，应该进行错误检查。

补充说明:

• 在 PHP 5.3.0 之前的版本中，可以使用 DateInterval::createFromDateString() 函数来计算日期间隔。但是，这种用法已被废弃，推荐使用 date_diff() 函数。