DateTimeImmutable::modify

(PHP 5 >= 5.5.0, PHP 7)

DateTimeImmutable::modify — Creates a new object with modified timestamp

Description

public DateTimeImmutable::modify ( string $modify ) : DateTimeImmutable

Creates a new DateTimeImmutable object with modified timestamp. The original object is not modified.

Parameters

object

Procedural style only: A DateTime object returned by date_create(). The function modifies this object.

modify

A date/time string. Valid formats are explained in Date and Time Formats.

Return Values

Returns the newly created object or FALSE on failure.