When a PHP application needs to creates a DateTimeImmutable value using createFromMutable, choosing the right API and checking its results helps keep code understandable and dependable. This guide explains DateTimeImmutable::createFromMutable with focused examples and important details.
What Is DateTimeImmutable::createFromMutable in PHP?
DateTimeImmutable::createFromMutable creates a DateTimeImmutable value using createFromMutable. createFromTimestamp() requires PHP 8.4+. The conversion methods preserve the instant and its time-zone information.
Syntax:
DateTimeImmutable::createFromMutable(object) : staticParameters and return value: Parameters: <required> DateTime $object. Check the return value or modified object rather than assuming the operation always succeeds.
Important: Use explicit IANA time zones in production and account for daylight-saving changes when calculating local schedules.
Example 1: Basic Usage
Start with a compact input so the main operation is visible.
<?php
$date = DateTimeImmutable::createFromMutable(new DateTime("2026-07-10", new DateTimeZone("UTC")));
echo $date->format("Y-m-d H:i:s.u P");
Output:
2026-07-10 00:00:00.000000 +00:00Creates a datetimeimmutable value using createfrommutable. createFromTimestamp() requires PHP 8.4+. The conversion methods preserve the instant and its time-zone information.
Example 2: A Different Input
The next example changes the input or option to illustrate another behavior.
<?php
$date = DateTimeImmutable::createFromMutable(new DateTime("2026-12-31", new DateTimeZone("Asia/Tokyo")));
echo $date->format("Y-m-d H:i:s.u P");
Output:
2026-12-31 00:00:00.000000 +09:00Compare this result with the first example. createFromTimestamp() requires PHP 8.4+. The conversion methods preserve the instant and its time-zone information.
Practical Example: Applying the Function
This example combines the API with a realistic processing step and shows where to check its result.
<?php
$source = new DateTime("2026-04-12", new DateTimeZone("UTC"));
$copy = DateTimeImmutable::createFromMutable($source);
echo $copy->format("c");
Output:
2026-04-12T00:00:00+00:00Adapt the inputs to your application and validate the output before storing or displaying it. createFromTimestamp() requires PHP 8.4+. The conversion methods preserve the instant and its time-zone information.
Important Behavior and Edge Cases
- Main purpose: Creates a datetimeimmutable value using createfrommutable.
- Errors and boundaries: createFromTimestamp() requires PHP 8.4+. The conversion methods preserve the instant and its time-zone information.
- Environment: Use explicit IANA time zones in production and account for daylight-saving changes when calculating local schedules.
Comparison With Related Functions
| Function or Approach | When to Use It |
|---|---|
DateTimeImmutable::createFromMutable | Creates a datetimeimmutable value using createfrommutable. |
| DateTimeImmutable | Consider this alternative when you need different behavior or a different abstraction. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Assuming the operation succeeds for every input | createFromTimestamp() requires PHP 8.4+. The conversion methods preserve the instant and its time-zone information. |
| Ignoring runtime requirements or variable output | Use explicit IANA time zones in production and account for daylight-saving changes when calculating local schedules. |
| Using the wrong API for the goal | Compare DateTimeImmutable::createFromMutable with DateTimeImmutable before selecting an approach. |
Key Takeaways
- Creates a datetimeimmutable value using createfrommutable.
- createFromTimestamp() requires PHP 8.4+. The conversion methods preserve the instant and its time-zone information.
- Use explicit IANA time zones in production and account for daylight-saving changes when calculating local schedules.
Use DateTimeImmutable::createFromMutable when you need to creates a DateTimeImmutable value using createFromMutable. The three examples move from a simple call to a practical use. Validate all external input and handle failures explicitly.