• PHP Video Tutorials

PHP date_sunset() Function


Advertisements

Definition and Usage

The date_sunset() function accepts a timestamp representing the given day and, returns the sunset time on that particular day.

Syntax

date_sunset($timestamp, [$format, $latitude, $longitude, $zenith, $gmtoffset])

Parameters

Sr.No Parameter & Description
1

timestamp (Mandatory)

This specifies a timestamp.

2

format (Optional)

This specifies the format in which you need the resultant value in. You can pass three constants as the value of this parameter namely; SUNFUNCS_RET_STRING (string), SUNFUNCS_RET_DOUBLE (float) and, SUNFUNCS_RET_TIMESTAMP integer.

3

latitude (Optional)

This specifies latitude of a location by default, this specifies the North direction. To specify a latitude value in south you need to pass it as a negative value.

4

longitude (Optional)

This specifies longitude of a location by default, this specifies the East direction. To specify a latitude value in West you need to pass it as a negative value.

5

zenith (Optional)

This specifies zenith value. This specifies the angle between the line perpendicular to the earth's surface and the centre of the sun.

6

gmtoffset (Optional)

This specifies the difference between GMT and local time in hours.

Return Values

PHP date_sunset() function returns the time of the sunset in desired format. Incase of failure, it returns the boolean value false.

PHP Version

This function was first introduced in PHP Version 5.0 and, works with all the later versions.

Example

Following example demonstrates the usage of the date_sunset() function −

Live Demo
<?php
   $sun_info = date_sunset("02-17-2012");
   print_r($sun_info);
?>

This will produce following result −

14:46

Example

Now lets invoke this function by, passing latitude and longitude values. If you want to pass latitude and longitude values it is mandatory to pass the value of required format too −

Live Demo
<?php
   $sun_info = date_sunset("02-03-2020",SUNFUNCS_RET_STRING, 23.4, -25);
   print_r("Sunset Time: ".$sun_info);
?>

This will produce following result −

Sunset Time: 19:05

Example

Following example verifies the case of no sunset −

<?php
   $sun_info = date_sunset("25-12-2016",SUNFUNCS_RET_STRING, 69, 41);
   print("Sunset Time: ".$sun_info);
   print("\n");
   var_dump($sun_info);
?>

This will produce following result −

Sunset Time:
bool(false)

Example

<?php
   echo("Date: " . date("D M d Y"));
   echo("\n");
   echo("Sunset time: ");
   echo(date_sunset(time(),SUNFUNCS_RET_STRING,38.4,-9,90,1));
?>

This will produce following result −

Date: Thu May 07 2020
Sunset time: 20:30
php_function_reference.htm
Advertisements