Oihana PHP

isWeekend.php

Table of Contents

Functions

isWeekend()  : bool
Tells whether a date falls on a weekend (Saturday or Sunday).

Functions

isWeekend()

Tells whether a date falls on a weekend (Saturday or Sunday).

isWeekend(DateTimeInterface $date) : bool
Parameters
$date : DateTimeInterface

The date to test.

Tags
example 
use function oihana\core\date\isWeekend;

isWeekend( new DateTimeImmutable( '2024-01-06' ) ) ; // true  (Saturday)
isWeekend( new DateTimeImmutable( '2024-01-08' ) ) ; // false (Monday)
author

Marc Alcaraz (ekameleon)

since
1.0.9
Return values
bool —

true if the date is a Saturday or a Sunday, false otherwise.

On this page

Search results