DateTimeImmutable::modify

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

DateTimeImmutable::modifyタイムスタンプを変更した新しいオブジェクトを作る

説明

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

タイムスタンプを変更した新しい DateTimeImmutable オブジェクトを作ります。 元のオブジェクトは変更されません。

パラメータ

object

手続き型のみ: date_create() が返す DateTime オブジェクト。 この関数は、このオブジェクトを変更します。

modifier

日付/時刻 文字列。有効な書式については 日付と時刻の書式 で説明しています。

戻り値

新しく作った DateTimeImmutable オブジェクトを返します。 失敗した場合に false を返します

例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, オブジェクト, 変更, 日付, 設定, 時刻, modify, 日時, 分秒, 年月