date_create_immutable()

date_create_immutable() — create a new DateTimeImmutable object.

Built-in function of PHP 8.5. The manual lists it as available in PHP 5 >= 5.5.0, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

This is the procedural version of DateTimeImmutable::__construct().

Signature

date_create_immutable(string $datetime = "now", ?DateTimeZone $timezone = null): DateTimeImmutable|false

Parameters

This function takes no parameters.

Return value

Returns a new DateTimeImmutable instance or false on failure

Example

The PHP manual ships no example for date_create_immutable(); the signature and the parameter table above are the contract.

All PHP 8.5 built-in functions

Reference card built from the PHP manual page date_create_immutable() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.