PHP Manual
DateTimeInterface
ふたつの DateTime オブジェクトの差を返す

DateTime::diff

DateTimeImmutable::diff

DateTime::diff

date_diff

(PHP 5 >= 5.3.0, PHP 7)

DateTime::diff -- DateTimeImmutable::diff -- DateTime::diff -- date_diff — ふたつの DateTime オブジェクトの差を返す

説明

オブジェクト指向型

public DateTime::diff ( DateTimeInterface $datetime2 [, bool $absolute = false ] ) : DateInterval

public DateTimeImmutable::diff ( DateTimeInterface $datetime2 [, bool $absolute = false ] ) : DateInterval

public DateTimeInterface::diff ( DateTimeInterface $datetime2 [, bool $absolute = false ] ) : DateInterval

手続き型

date_diff ( DateTime $datetime1 , DateTime $datetime2 [, bool $absolute = false ] ) : DateInterval

ふたつの DateTime オブジェクトの差を返します。

パラメータ

datetime: 比較する日付。
absolute: 間隔が正の数になるようにするか否か。

返り値

ふたつの日付の差をあらわす DateInterval オブジェクトを返します。失敗した場合に FALSE を返します

例

例1 DateTime::diff() の例

オブジェクト指向型


<?php
$datetime1 = new DateTime('2009-10-11');
$datetime2 = new DateTime('2009-10-13');
$interval = $datetime1->diff($datetime2);
echo $interval->format('%R%a days');
?>

手続き型


<?php
$datetime1 = date_create('2009-10-11');
$datetime2 = date_create('2009-10-13');
$interval = date_diff($datetime1, $datetime2);
echo $interval->format('%R%a days');
?>

上の例の出力は以下となります。

+2 days

例2 DateTime オブジェクトの比較

注意:
PHP 5.2.2 以降では、DateTime オブジェクトを比較演算子で比較できるようになりました。


<?php
$date1 = new DateTime("now");
$date2 = new DateTime("tomorrow");

var_dump($date1 == $date2);
var_dump($date1 < $date2);
var_dump($date1 > $date2);
?>

上の例の出力は以下となります。

bool(false)
bool(true)
bool(false)

参考

DateInterval::format() - 間隔をフォーマットする
DateTime::add() - 年月日時分秒の値を DateTime オブジェクトに加える
DateTime::sub() - 年月日時分秒の値を DateTime オブジェクトから引く