Php/docs/datetimezone.getoffset
DateTimeZone::getOffset
timezone_offset_get
(PHP 5 >= 5.2.0, PHP 7)
DateTimeZone::getOffset -- timezone_offset_get — Returns the timezone offset from GMT
Description
Object oriented style
public DateTimeZone::getOffset
( DateTimeInterface $datetime
) : int|false
Procedural style
timezone_offset_get
( DateTimeZone $object
, DateTimeInterface $datetime
) : int|false
This function returns the offset to GMT for the date/time specified in the
datetime
parameter. The GMT offset is calculated
with the timezone information contained in the DateTimeZone object being used.
Parameters
object
- Procedural style only: A DateTimeZone object returned by timezone_open()
datetime
- DateTime that contains the date/time to compute the offset from.
Return Values
Returns time zone offset in seconds on success or FALSE
on failure.
Changelog
Version | Description |
---|---|
5.5.19, 5.6.3 | datetime type changed to
DateTimeInterface. Previously, DateTime. |
Examples
Example #1 DateTimeZone::getOffset() examples
<?php// Create two timezone objects, one for Taipei (Taiwan) and one for// Tokyo (Japan)$dateTimeZoneTaipei = new DateTimeZone("Asia/Taipei");$dateTimeZoneJapan = new DateTimeZone("Asia/Tokyo");// Create two DateTime objects that will contain the same Unix timestamp, but// have different timezones attached to them.$dateTimeTaipei = new DateTime("now", $dateTimeZoneTaipei);$dateTimeJapan = new DateTime("now", $dateTimeZoneJapan);// Calculate the GMT offset for the date/time contained in the $dateTimeTaipei// object, but using the timezone rules as defined for Tokyo// ($dateTimeZoneJapan).$timeOffset = $dateTimeZoneJapan->getOffset($dateTimeTaipei);// Should show int(32400) (for dates after Sat Sep 8 01:00:00 1951 JST).var_dump($timeOffset);?>