function DateHelper::dayOfWeek

Same name in other branches
  1. 9 core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::dayOfWeek()
  2. 10 core/lib/Drupal/Core/Datetime/DateHelper.php \Drupal\Core\Datetime\DateHelper::dayOfWeek()
  3. 11.x 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.

1 call to DateHelper::dayOfWeek()
DateHelper::dayOfWeekName in core/lib/Drupal/Core/Datetime/DateHelper.php
Returns translated name of the day of week for a given date.

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;
}

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