DateTime::sub
date_sub
(PHP 5 >= 5.3.0, PHP 7)
DateTime::sub -- date_sub — 年月日時分秒の値を DateTime オブジェクトから引く
パラメータ
-
object -
手続き型のみ: date_create() が返す DateTime オブジェクト。 この関数は、このオブジェクトを変更します。
-
interval -
DateInterval オブジェクト。
返り値
メソッドチェインに使う DateTime オブジェクトを返します。失敗した場合に FALSE を返します。
例
例1 DateTime::sub() の例
オブジェクト指向型
<?php
$date = new DateTime('2000-01-20');
$date->sub(new DateInterval('P10D'));
echo $date->format('Y-m-d') . "\n";
?>
手続き型
<?php
$date = date_create('2000-01-20');
date_sub($date, date_interval_create_from_date_string('10 days'));
echo date_format($date, 'Y-m-d');
?>
上の例の出力は以下となります。
2000-01-10
例2 DateTime::sub() の別の例
<?php
$date = new DateTime('2000-01-20');
$date->sub(new DateInterval('PT10H30S'));
echo $date->format('Y-m-d H:i:s') . "\n";
$date = new DateTime('2000-01-20');
$date->sub(new DateInterval('P7Y5M4DT4H3M2S'));
echo $date->format('Y-m-d H:i:s') . "\n";
?>
上の例の出力は以下となります。
2000-01-19 13:59:30 1992-08-15 19:56:58
例3 月を減算するときの注意点
<?php
$date = new DateTime('2001-04-30');
$interval = new DateInterval('P1M');
$date->sub($interval);
echo $date->format('Y-m-d') . "\n";
$date->sub($interval);
echo $date->format('Y-m-d') . "\n";
?>
上の例の出力は以下となります。
2001-03-30 2001-03-02
注意
PHP 5.2 では、かわりに DateTime::modify() を使うことができます。
参考
- DateTime::add() - 年月日時分秒の値を DateTime オブジェクトに加える
- DateTime::diff() - ふたつの DateTime オブジェクトの差を返す
- DateTime::modify() - タイムスタンプを変更する
忘却曲線を使ってこの知識を確実に記憶に残す
