timezone_offset_get()

timezone_offset_get() — Alias of DateTimeZone::getOffset().

Built-in function of PHP 8.5. The manual lists it as available in PHP 5 >= 5.2.0, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

timezone_offset_get() is an alias of DateTimeZone::getOffset(): same parameters, same return value.

Signature

timezone_offset_get(DateTimeZone $object, DateTimeInterface $datetime): int

Parameters

ParameterTypeWhat it takes
$objectDateTimeZoneProcedural style only: A DateTimeZone object returned by timezone_open()
$datetimeDateTimeInterfaceDateTime that contains the date/time to compute the offset from.

Return value

Returns time zone offset in seconds.

Example

A runnable snippet:

// 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);

Output:

int(32400)

All PHP 8.5 built-in functions

Reference card built from the PHP manual page timezone_offset_get() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.