DateTimeInterface::getOffset
DateTimeImmutable::getOffset
DateTime::getOffset
date_offset_get
(PHP 5 >= 5.2.0, PHP 7, PHP 8)
DateTimeInterface::getOffset -- DateTimeImmutable::getOffset -- DateTime::getOffset -- date_offset_get — Returns the timezone offset
Description
Object-oriented style
Procedural style
Returns the timezone offset.
Parameters
-
object
-
Procedural style only: A DateTime object returned by date_create()
Return Values
Returns the timezone offset in seconds from UTC on success.
Changelog
Version | Description |
---|---|
8.0.0 |
Prior to this version, false was returned on failure.
|
Examples
Example #1 DateTime::getOffset() example
Object-oriented style
<?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";
?>
Procedural style
<?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 examples will output:
-18000 -14400
Note: -18000 = -5 hours, -14400 = -4 hours.