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

DateTimeInterface::getTimestamp

PHP function Edit on GitHub ✎

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

Gets the Unix timestamp

Description

Oop

DateTimeInterface::getTimestamp(): int
DateTimeImmutable::getTimestamp(): int
DateTime::getTimestamp(): int

Procedural

date_timestamp_get(DateTimeInterface $object): int

Gets the Unix timestamp.

Parameters Parameters

Return Values

Returns the Unix timestamp representing the date.

Errors/Exceptions

If the timestamp cannot be represented as Integer, a DateRangeError is thrown. Prior to PHP 8.3.0, a ValueError is thrown. And, prior to PHP 8.0.0, false was returned in this case. Still, the timestamp can be retrieved as String by using DateTimeInterface::format with the U format.

Changelog

VersionDescription
8.3.0The out-of-range exception is now DateRangeError.
8.0.0These functions no longer return false on failure.

Examples

DateTime::getTimestamp() example

Oop

php
<?php
$date = new DateTimeImmutable();
echo $date->getTimestamp();

The above example will output something similar to:

output
1272509157

Procedural

php
<?php
$date = date_create();
echo date_timestamp_get($date);

The above example will output something similar to:

output
1272509157

If you need to retrieve the timestamp with millisecond or microsecond resolution, then you can use the DateTimeInterface::format() function.

Retrieving timestamp with milli and microsecond resolution

Oop

php
<?php
$date = new DateTimeImmutable();
$milli = (int) $date->format('Uv'); // Timestamp in milliseconds
$micro = (int) $date->format('Uu'); // Timestamp in microseconds

echo $milli, "\n", $micro, "\n";

The above example will output something similar to:

output
1674057635586
1674057635586918

See Also

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