(PHP 5 >= 5.3.0, PHP 7, PHP 8)
DatePeriod::__construct — Creates a new DatePeriod object
$start,$interval,$recurrences,$options = 0$start,$interval,$end,$options = 0This variant of the constructor has been deprecated, use DatePeriod::createFromISO8601String() instead.
Creates a new DatePeriod object.
DatePeriod objects can be used as an iterator to
generate a number of DateTimeImmutable or
DateTime object from a start
date, a interval, and an end
date or the number of recurrences.
The class of returned objects is equivalent to the
DateTimeImmutable or DateTime
ancestor class of the start object.
startThe start date of the period. Included by default in the result set.
intervalThe interval between recurrences within the period.
recurrences
The number of recurrences. The number of returned results is
one higher than this, as the start date is included in the result set
by default. Must be greater than 0.
endThe end date of the period. Excluded by default from the result set.
isostrA subset of the » ISO 8601 repeating interval specification.
Examples of some ISO 8601 interval specification features that PHP does not support are:
R0/)
Z), such as +02:00.
optionsA bit field which can be used to control certain behaviour with start- and end- dates.
With DatePeriod::EXCLUDE_START_DATE you
exclude the start date from the set of recurring dates within the
period.
With DatePeriod::INCLUDE_END_DATE you
include the end date in the set of recurring dates within the
period.
Throws an DateMalformedPeriodStringException when
the isostr cannot be parsed as a valid ISO 8601
period. Prior to PHP 8.3, this was
Exception.
| Version | Description |
|---|---|
| 8.3.0 | Now throws DateMalformedPeriodStringException instead of Exception. |
| 8.2.0 |
The DatePeriod::INCLUDE_END_DATE constant has been added.
|
| 7.2.19, 7.3.6, 7.4.0 |
recurrences must be greater than 0 now.
|
Example #1 DatePeriod example
<?php
$start = new DateTime('2012-07-01');
$interval = new DateInterval('P7D');
$end = new DateTime('2012-07-31');
$recurrences = 4;
$iso = 'R4/2012-07-01T00:00:00Z/P7D';
// All of these periods are equivalent.
$period = new DatePeriod($start, $interval, $recurrences);
$period = new DatePeriod($start, $interval, $end);
$period = new DatePeriod($iso);
// By iterating over the DatePeriod object, all of the
// recurring dates within that period are printed.
foreach ($period as $date) {
echo $date->format('Y-m-d')."\n";
}
?>The above example will output:
2012-07-01 2012-07-08 2012-07-15 2012-07-22 2012-07-29
Example #2 DatePeriod example with DatePeriod::EXCLUDE_START_DATE
<?php
$start = new DateTime('2012-07-01');
$interval = new DateInterval('P7D');
$end = new DateTime('2012-07-31');
$period = new DatePeriod($start, $interval, $end,
DatePeriod::EXCLUDE_START_DATE);
// By iterating over the DatePeriod object, all of the
// recurring dates within that period are printed.
// Note that, in this case, 2012-07-01 is not printed.
foreach ($period as $date) {
echo $date->format('Y-m-d')."\n";
}
?>The above example will output:
2012-07-08 2012-07-15 2012-07-22 2012-07-29
Example #3 DatePeriod example showing all last Thursdays in a year
<?php
$begin = new DateTime('2021-12-31');
$end = new DateTime('2022-12-31 23:59:59');
$interval = DateInterval::createFromDateString('last thursday of next month');
$period = new DatePeriod($begin, $interval, $end, DatePeriod::EXCLUDE_START_DATE);
foreach ($period as $dt) {
echo $dt->format('l Y-m-d'), "\n";
}
?>The above example will output:
Thursday 2022-01-27 Thursday 2022-02-24 Thursday 2022-03-31 Thursday 2022-04-28 Thursday 2022-05-26 Thursday 2022-06-30 Thursday 2022-07-28 Thursday 2022-08-25 Thursday 2022-09-29 Thursday 2022-10-27 Thursday 2022-11-24 Thursday 2022-12-29
Unbound numbers of repetitions as specified by ISO 8601 section 4.5
"Recurring time interval" are not supported, i.e. neither passing
"R/..." as isostr nor passing
null as end would work.