Home/ Manual/ datetime / dateperiod/ DatePeriod::getEndDate

DatePeriod::getEndDate

PHP function Edit on GitHub ✎

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

Gets the end date

Description

Oop

DatePeriod::getEndDate(): DateTimeInterface|null

Gets the end date of the period.

Parameters Parameters

Return Values

Returns null if the DatePeriod does not have an end date. For example, when initialized with the recurrences parameter, or the isostr parameter without an end date.

Returns a DateTimeImmutable object when the DatePeriod is initialized with a DateTimeImmutable object as the end parameter.

Returns a cloned DateTime object representing the end date otherwise.

Examples

DatePeriod::getEndDate example

php

<?php
$period = new DatePeriod(
    new DateTime('2016-05-16T00:00:00Z'),
    new DateInterval('P1D'),
    new DateTime('2016-05-20T00:00:00Z')
);
$start = $period->getEndDate();
echo $start->format(DateTime::ISO8601);

Outputs

output

2016-05-20T00:00:00+0000

DatePeriod::getEndDate without an end date

php

<?php
$period = new DatePeriod(
    new DateTime('2016-05-16T00:00:00Z'),
    new DateInterval('P1D'),
    7
);
var_dump($period->getEndDate());

The above example will output: