php / 8.1.5 / datetime.gettimestamp.html /

DateTime::getTimestamp

DateTimeImmutable::getTimestamp

DateTimeInterface::getTimestamp

date_timestamp_get

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

DateTime::getTimestamp -- DateTimeImmutable::getTimestamp -- DateTimeInterface::getTimestamp -- date_timestamp_getGets the Unix timestamp

Description

Object-oriented style

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

Procedural style

date_timestamp_get(DateTimeInterface $object): int

Gets the Unix timestamp.

Parameters

This function has no parameters.

Return Values

Returns the Unix timestamp representing the date.

Errors/Exceptions

If the timestamp cannot be represented as int, a ValueError is thrown. 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

Version Description
8.0.0 These functions no longer return false on failure.

Examples

Example #1 DateTime::getTimestamp() example

Object-oriented style

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

Procedural style

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

The above examples will output something similar to:

1272509157

See Also

© 1997–2021 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/datetime.gettimestamp.php