PHP Tutorial - PHP date_sunset() Function






Definition

The date_sunset() function returns the sunset time for a specified day and location.

date_sunrise() function returns the sunrise time for a specified day and location.

Syntax

PHP date_sunset() Function has the following syntax.

date_sunset(timestamp,format,latitude,longitude,zenith,gmtoffset);

Parameter

ParameterIs RequiredDescription
timestampRequired.Timestamp of the day from which the sunset time is taken
formatOptional.Format to return the result:
latitudeOptional.Latitude of the location. Defaults to North. To specify a value for South, pass in a negative value
longitudeOptional.Longitude of the location. Defaults to East. To specify a value for West, pass in a negative value
zenithOptional.Defaults to date.sunset_zenith
gmtoffsetOptional.Difference between GMT and local time in hours

Format has the following available value.

ValueDescription
SUNFUNCS_RET_STRINGreturns the result as string. e.g. 15:46 (This is default)
SUNFUNCS_RET_DOUBLEreturns the result as float. e.g. 12.123456
SUNFUNCS_RET_TIMESTAMPreturns the result as integer (timestamp). e.g. 1211233211)




Return

PHP date_sunset() Function returns the time of the sunset, in the specified format, on success. FALSE on failure.

Example

Return the sunset time for Lisbon, Portugal today:


<?php
echo("Lisbon, Portugal: Date: " . date("D M d Y"));
echo("<br>Sunset time: ");
echo(date_sunset(time(),SUNFUNCS_RET_STRING,18.1,-9,80,1));
?>

The code above generates the following result.