DateTimeImmutable::setTimezone

Sets the time zone

Description

public DateTimeImmutable DateTimeImmutable::setTimezone(DateTimeZone $timezone)

Returns a new DateTimeImmutable object with a new timezone set.

Parameters

timezone

A DateTimeZone object representing the desired time zone.

Return Values

Returns a new modified DateTimeImmutable object for method chaining. The underlaying point-in-time is not changed when calling this method.

Examples

Example #1 DateTimeImmutable::setTimeZone example

Object-oriented style

<?php
$date = new DateTimeImmutable('2000-01-01', new DateTimeZone('Pacific/Nauru'));
echo $date->format('Y-m-d H:i:sP') . "\n";

$newDate = $date->setTimezone(new DateTimeZone('Pacific/Chatham'));
echo $newDate->format('Y-m-d H:i:sP') . "\n";
?>

The above examples will output:

2000-01-01 00:00:00+12:00
2000-01-01 01:45:00+13:45

See Also

  • DateTimeImmutable::getTimezone
  • DateTimeZone::__construct