PHP DatePeriod class

The PHP DatePeriod class represents a date period. A date period allows iteration over a set of dates and times, recurring at regular intervals, over a given period.

Class synopsis

class DatePeriod implements Traversable {
  //Constants
  const int EXCLUDE_START_DATE = 1;
  
  //Properties
  public int $recurrences;
  public bool $include_start_date;
  public DateTimeInterface $start;
  public DateTimeInterface $current;
  public DateTimeInterface $end;
  public DateInterval $interval;

  //Methods
  public __construct(
    DateTimeInterface $start,
    DateInterval $interval,
    int $recurrences,
    int $options = 0
  )
  public __construct(
    DateTimeInterface $start,
    DateInterval $interval,
    DateTimeInterface $end,
    int $options = 0
  )
  public __construct(string $isostr, int $options = 0)
  public getDateInterval(): DateInterval
  public getEndDate(): ?DateTimeInterface
  public getRecurrences(): ?int
  public getStartDate(): DateTimeInterface
}

Predefined Constants

DatePeriod::EXCLUDE_START_DATE

Exclude start date, used in DatePeriod::__construct().

Properties

`recurrences`	The number of recurrences, if the DatePeriod instance had been created by explicitly passing $recurrences.
`include_start_date`	Whether to include the start date in the set of recurring dates or not.
`start`	The start date of the period.
`current`	During iteration this will contain the current date within the period.
`end`	The end date of the period.
`interval`	An ISO 8601 repeating interval specification.

❮ PHP Date and Time Reference