CFLib.org – Common Function Library Project

Description:
This function returns true or false depending on if a date falls on the weekend. This is defined as either Saturday or Sunday. The function defaults to today.

Return Values:
Returns a boolean.

Example:

<CFOUTPUT>
Is it the weekend? #IsWeekend()#<BR>
</CFOUTPUT>

Parameters:

Full UDF Source:

/**
 * Returns true if a date is on the weekend.
 * 
 * @param Date      Defaults to today. 
 * @return Returns a boolean. 
 * @author Raymond Camden (ray@camdenfamily.com) 
 * @version 1, August 17, 2001 
 */
function IsWeekend() {
    var today = Now();
    if(ArrayLen(Arguments)) today = Arguments[1];
    return (DayOfWeek(today) IS 1 OR DayOfWeek(today) IS 7);
}