SymfonyWorld Online 2022 Winter Edition

DateTimeImmutable::setTimestamp

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

DateTimeImmutable::setTimestampSets the date and time based on a Unix timestamp

Description

public DateTimeImmutable::setTimestamp(int $timestamp): DateTimeImmutable

Returns a new DateTimeImmutable object with the date and time set based on an Unix timestamp.

Parameters

object

Procedural style only: A DateTime object returned by date_create(). The function modifies this object.

timestamp

Unix timestamp representing the date. Setting timestamps outside the range of int is possible by using DateTimeImmutable::modify() with the @ format.

Return Values

Returns a new modified DateTimeImmutable object or false on failure.

Examples

Example #1 DateTimeImmutable::setTimestamp() example

Object-oriented style

<?php
$date 
= new DateTimeImmutable();
echo 
$date->format('U = Y-m-d H:i:s') . "\n";

$newDate $date->setTimestamp(1171502725);
echo 
$newDate->format('U = Y-m-d H:i:s') . "\n";
?>

The above examples will output something similar to:

1272508903 = 2010-04-28 22:41:43
1171502725 = 2007-02-14 20:25:25

See Also

add a note

User Contributed Notes 2 notes

up
10
ben at hl9 dot net
3 years ago
Note that this is not the right way to initiate a \DateTimeImmutable object with a numeric Unix timestamp. 

<?php
// Wrong, despite the documention *kind of* alluding to it
$obj = \DateTimeImmutable::setTimestamp(time() - 1);

// Also won't work
$obj = new \DateTimeImmutable(time() - 1)

// Correct, works, clean single line
$obj = (new \DateTimeImmutable())->setTimestamp(time() - 1);
?>

... In fact, this is a non-static method and thus should not be called statically.
up
2
Philip
11 months ago
This function will not change the value of the DateTimeImmutable object as the method name might suggest. The object, after all, immutable.

<?php
   $dti
= new DateTimeImmutable();
   echo
$dti->getTimestamp(); // e.g. 123456789
  
$dti->setTimestamp(987654321);
   echo
$dti->getTimestamp(); // 123456789

  
$x = $dti->setTimestamp (987654321);
   echo
$x->getTimestamp(); // 987654321
?>
To Top