php8.5
Home/ Manual/ datetime / datetimeinterface/ DateTimeInterface::getOffset

DateTimeInterface::getOffset

PHP function Edit on GitHub ✎

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

Returns the timezone offset

Description

Oop

DateTimeInterface::getOffset(): int
DateTimeImmutable::getOffset(): int
DateTime::getOffset(): int

Procedural

date_offset_get(DateTimeInterface $object): int

Returns the timezone offset.

Parameters

Return Values

Returns the timezone offset in seconds from UTC on success.

Examples

DateTime::getOffset() example

Oop

php
<?php
$winter = new DateTimeImmutable('2010-12-21', new DateTimeZone('America/New_York'));
$summer = new DateTimeImmutable('2008-06-21', new DateTimeZone('America/New_York'));

echo $winter->getOffset() . "\n";
echo $summer->getOffset() . "\n";

The above example will output:

output
-18000
-14400

Procedural

php
<?php
$winter = date_create('2010-12-21', timezone_open('America/New_York'));
$summer = date_create('2008-06-21', timezone_open('America/New_York'));

echo date_offset_get($winter) . "\n";
echo date_offset_get($summer) . "\n";

The above example will output:

output
-18000
-14400

Note: -18000 = -5 hours, -14400 = -4 hours.

Source: reference/datetime/datetimeinterface/getoffset.xml · from the official PHP manual (php/doc-en)