date_sunset
int$timestamp,
[int$returnFormat = SUNFUNCS_RET_STRING],
[float|null$latitude = null],
[float|null$longitude = null],
[float|null$zenith = null],
[float|null$utcOffset = null]
): string|int|float|false
date_sunset returns the sunset time for a given day (specified as a timestamp) and location.
Parameters
- timestamp
-
The timestamp of the day from which the sunset time is taken.
- returnFormat
-
returnFormat constants
constant description example SUNFUNCS_RET_STRING returns the result as string 16:46 SUNFUNCS_RET_DOUBLE returns the result as float 16.78243132 SUNFUNCS_RET_TIMESTAMP returns the result as int (timestamp) 1095034606 - latitude
-
Defaults to North, pass in a negative value for South. See also: date.default_latitude
- longitude
-
Defaults to East, pass in a negative value for West. See also: date.default_longitude
- zenith
-
zenith is the angle between the center of the sun and a line perpendicular to earth's surface. It defaults to date.sunset_zenith
Common zenith angles
Angle Description 90°50' Sunset: the point where the sun becomes invisible. 96° Civil twilight: conventionally used to signify the end of dusk. 102° Nautical twilight: the point at which the horizon ends being visible at sea. 108° Astronomical twilight: the point at which the sun ends being the source of any illumination. - utcOffset
-
Specified in hours. The utcOffset is ignored, if returnFormat is SUNFUNCS_RET_TIMESTAMP.
Return Values
Returns the sunset time in a specified returnFormat on success or false on failure. One potential reason for failure is that the sun does not set at all, which happens inside the polar circles for part of the year.
Exceptions and Errors
Every call to a date/time function will generate a E_WARNING if the time zone is not valid. See also date_default_timezone_set
Changelog
| Version | Description |
| 8.1.0 | This function has been deprecated in favor of date_sun_info. |
| 8.0.0 | latitude, longitude, zenith and utcOffset are nullable now. |