PHP 8.4.22 Released!

DateTimeImmutable::setMicrosecond

(PHP 8 >= 8.4.0)

DateTimeImmutable::setMicrosecondSets microsecond part of the time

Description

#[\NoDiscard(message: "as DateTimeImmutable::setMicrosecond() does not modify the object itself")]
public function DateTimeImmutable::setMicrosecond(int $microsecond): static

Returns a new DateTimeImmutable object constructed from the old one, with modified microsecond part.

Parameters

microsecond
The microsecond value to set (0 to 999999).

Return Values

Returns a new DateTimeImmutable object with the modified data.

Errors/Exceptions

If the microsecond is outside the range [0, 999999], a DateRangeError is thrown.

Examples

Example #1 DateTimeImmutable::setMicrosecond() example

<?php
$date
= DateTimeImmutable::createFromTimestamp(123.456789);
echo
$date->format('Y-m-d H:i:s.u') . PHP_EOL;
$date = $date->setMicrosecond(987654);
echo
$date->format('Y-m-d H:i:s.u') . PHP_EOL;
?>

The above example will output:

1970-01-01 00:02:03.456789
1970-01-01 00:02:03.987654

See Also

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top