DateFormat()
Formats a date object to a given string output.
DateFormat( date=any, mask=string, timezone=timezone );
Returns: String
Argument | Description | Default |
---|---|---|
date
any,
required
|
date object; for example, now() |
|
mask
string,
optional
|
Date formatting mask:
The following masks are options to format the full date and cannot be combined with other masks:
|
dd-mmm-yy |
timezone
timezone,
optional
|
A datetime object is independent of a specific timezone; it is only an offset in milliseconds from The timezone only comes into play when you need specific information like hours in a day, minutes in a hour or which day it is as these calculations depend on the timezone. A timezone must be specified in order to translate the date object to something else. If you do not provide the timezone in the function call, it will default to the timezone specified in the Lucee Administrator (Settings/Regional), or the timezone specified for the current request using the function setTimezone(). You can find a list of all available timezones in the Lucee administrator (Settings/Regional). Some examples of valid timezones include:
|
Examples
// the below code formats the date & show all the parts as two digits
writedump(dateFormat(now(), 'yy-mm-dd'));
//Day of the week as a three-letter abbreviation.
writedump(dateFormat(now(), 'ddd,dd/mm/yyyy'));
//Day of the week as its full name.
writedump(dateFormat(now(), 'dddd,dd/mm/yyyy'));
// the below code formats the month as short string notation
writedump(dateFormat(now(), 'yyyy/mmm/dd'));
// the below code formats the date & separate date parts with dot
writedump(dateFormat(now(), 'yyyy.mmm.dd'));
// the below code formats the date & show the full month in string
writedump(dateFormat(now(), 'yyyy-mmmm-dd'));
// the below code returns the date with the format of full, long, medium, short
dt=createDate(2018);
writedump(dateFormat(dt,"full"));
writedump(dateFormat(dt,"long"));
writedump(dateFormat(dt,"medium"));
writedump(dateFormat(dt,"short"));
//Member function, able to format the date as normal function with all possibilities
d1=createDate(2018,07,25)
writeDump(d1.dateFormat("MM/DD/YYYY"));
writeDump(d1.dateFormat("dddd,MM/DD/YYYY"));
See also
- Date and time
- Strings
- Formatting
- LSDateFormat()
- datetime.dateFormat()
- Search Issue Tracker
- Search Lucee Test Cases (good for further, detailed examples)