function DateHelper::daysInMonth

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::daysInMonth()
  2. 8.9.x core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::daysInMonth()
  3. 10 core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::daysInMonth()

Identifies the number of days in a month for a date.

Parameters

mixed $date: (optional) A DrupalDateTime object or a date string. Defaults to NULL, which means to use the current date.

Return value

int The number of days in the month, or null if the $date has errors.

1 call to DateHelper::daysInMonth()
DateHelperTest::testDaysInMonth in core/tests/Drupal/Tests/Core/Datetime/DateHelperTest.php
@covers ::daysInMonth

File

core/lib/Drupal/Core/Datetime/DateHelper.php, line 456

Class

DateHelper
Defines Gregorian Calendar date values.

Namespace

Drupal\Core\Datetime

Code

public static function daysInMonth($date = NULL) {
    $date = $date ?? 'now';
    if (!$date instanceof DrupalDateTime) {
        $date = new DrupalDateTime($date);
    }
    if (!$date->hasErrors()) {
        return $date->format('t');
    }
    return NULL;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.