public static function DateHelper::dayOfWeek in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::dayOfWeek()
2. 9 core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::dayOfWeek()

Returns day of week for a given date (0 = Sunday).

Parameters

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

Return value

int The number of the day in the week.

File

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

Class

DateHelper

Defines Gregorian Calendar date values.

Namespace

Drupal\Core\Datetime

Code

public static function dayOfWeek($date = NULL) {
  if (!$date instanceof DrupalDateTime) {
    $date = new DrupalDateTime($date);
  }
  if (!$date
    ->hasErrors()) {
    return $date
      ->format('w');
  }
  return NULL;
}