date_sunset
Description
The date_sunset of Date / Time for PHP returns time of sunset for a given day and location.
Syntax
date_sunset( int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ?float $latitude = null, ?float $longitude = null, ?float $zenith = null, ?float $utcOffset = null ): string|int|float|false
Parameters
timestamp
The timestamp of the day from which the sunset time is taken.
returnFormat
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 integer (timestamp) | 1095034606 |
latitude
Defaults to North, pass in a negative value for South. See also: default_latitude
longitude
Defaults to East, pass in a negative value for West. See also: 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
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
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.
Examples
1 · timestamp
<? $timestamp = time(); $return = date_sunset($timestamp); echo $return; ?>
15:48
2 · returnFormat · SUNFUNCS_RET_STRING
<? $timestamp = time(); $returnFormat = SUNFUNCS_RET_STRING; $return = date_sunset($timestamp, $returnFormat); echo $return; ?>
15:48
3 · returnFormat · SUNFUNCS_RET_DOUBLE
<? $timestamp = time(); $returnFormat = SUNFUNCS_RET_DOUBLE; $return = date_sunset($timestamp, $returnFormat); echo $return; ?>
15.812978579946
4 · returnFormat · SUNFUNCS_RET_TIMESTAMP
<? $timestamp = time(); $returnFormat = SUNFUNCS_RET_TIMESTAMP; $return = date_sunset($timestamp, $returnFormat); echo $return; ?>
1726242526
5 · latitude
<? $timestamp = time(); $returnFormat = SUNFUNCS_RET_STRING; $latitude = 44.36; $return = date_sunset($timestamp, $returnFormat, $latitude); echo $return; ?>
15:54
6 · longitude
<? $timestamp = time(); $returnFormat = SUNFUNCS_RET_STRING; $latitude = 44.36; $longitude = -110.30; $return = date_sunset($timestamp, $returnFormat, $latitude, $longitude); echo $return; ?>
01:36
7 · zenith
<? $timestamp = time(); $returnFormat = SUNFUNCS_RET_STRING; $latitude = 44.36; $longitude = -110.30; $zenith = 90.58; $return = date_sunset($timestamp, $returnFormat, $latitude, $longitude, $zenith); echo $return; ?>
01:34
8 · utcOffset
<? $timestamp = time(); $returnFormat = SUNFUNCS_RET_STRING; $latitude = 44.36; $longitude = -110.30; $zenith = 90.58; $utcOffset = 1; $return = date_sunset($timestamp, $returnFormat, $latitude, $longitude, $zenith, $utcOffset); echo $return; ?>
02:34
9 · no sunset
<? $timestamp = strtotime("2017-12-21"); $returnFormat = SUNFUNCS_RET_STRING; $latitude = 69.245833; $longitude = -53.537222; $return = date_sunset($timestamp, $returnFormat, $latitude, $longitude); var_export($return); ?>
false
Links
Date / Time
- checkdate
- date
- date_add
- date_create
- date_create_from_format
- date_create_immutable
- date_create_immutable_from_format
- date_date_set
- date_default_timezone_get
- date_default_timezone_set
- date_diff
- date_format
- date_get_last_errors
- date_interval_create_from_date_string
- date_interval_format
- date_isodate_set
- date_modify
- date_offset_get
- date_parse
- date_parse_from_format
- date_sub
- date_sun_info
- date_sunrise
- date_time_set
- date_timestamp_get
- date_timestamp_set
- date_timezone_get
- date_timezone_set
- getdate
- gettimeofday
- gmdate
- gmmktime
- gmstrftime
- idate
- localtime
- microtime
- mktime
- strftime
- strptime
- strtotime
- time
- timezone_abbreviations_list
- timezone_identifiers_list
- timezone_location_get
- timezone_name_from_abbr
- timezone_name_get
- timezone_offset_get
- timezone_open
- timezone_transitions_get
- timezone_version_get