DateTime::getOffset

DateTimeImmutable::getOffset

DateTimeInterface::getOffset

date_offset_get

(PHP 5 >= 5.2.0, PHP 7)

DateTime::getOffset -- DateTimeImmutable::getOffset -- DateTimeInterface::getOffset -- date_offset_get — Returns the timezone offset

Description

Object oriented style

public int DateTime::getOffset ( void )

public int DateTimeImmutable::getOffset ( void )

public int DateTimeInterface::getOffset ( void )

Procedural style

int date_offset_get ( DateTimeInterface $object )

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 or FALSE on failure.

Examples

Example #1 DateTime::getOffset() example

Object oriented style


<?php
$winter = new DateTime('2010-12-21', new DateTimeZone('America/New_York'));
$summer = new DateTime('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.

User Contributed Notes

s7sunder at gmail dot com

2 years ago


This will be useful for converting offset values into GMT format

<?php

  //target time zone
  $target_time_zone = new DateTimeZone('America/Los_Angeles');

  //find kolkata time 
  $kolkata_date_time = new DateTime('now', $target_time_zone);
  
  //get the exact GMT format
  echo 'GMT '.$kolkata_date_time->format('P');