PHP IntlCalendar::createInstance() Method: Usage and Examples

When you need to create an ICU calendar for a time zone and locale, it helps to understand both the normal result and what changes with different inputs. This guide focuses on practical examples rather than repeating PHP background material.

IntlCalendar::createInstance provides the behavior described below. IntlCalendar represents a locale-aware ICU calendar. Month indexes are zero-based, while epoch time uses milliseconds.

What Is IntlCalendar::createInstance in PHP?

Create an icu calendar for a time zone and locale. IntlCalendar represents a locale-aware ICU calendar. Month indexes are zero-based, while epoch time uses milliseconds.

Its syntax is:

$calendar->createInstance(...)

Parameters and return value: Read the argument names and optional values in the signature above. Methods use an existing object, while stand-alone functions take direct arguments. The examples demonstrate the relevant arguments and the value returned or the object modified.

Important: ICU calendar types and local fields are not interchangeable with Unix timestamps.

Example 1: Basic Usage

This first example demonstrates how to create an ICU calendar for a time zone and locale with a small input.

<?php

$calendar = IntlCalendar::createInstance("UTC", "en_US");
$localCalendar = IntlCalendar::createInstance("Europe/Paris", "fr_FR");
echo $localCalendar->getType();

The example uses the simplest useful form. IntlCalendar represents a locale-aware ICU calendar. Month indexes are zero-based, while epoch time uses milliseconds. The output may depend on the active ICU locale, PHP configuration, or input supplied to the function.

Example 2: Another Case

Here the input or option changes, making it easier to see where the behavior differs. ICU calendar types and local fields are not interchangeable with Unix timestamps.

<?php

$calendar = IntlCalendar::createInstance("UTC", "en_US");
$localCalendar = IntlCalendar::createInstance("UTC", "en_US");
echo $localCalendar->getTimeZone()->getID();

Compare the result to the first example. DateTimeImmutable is often simpler for Gregorian dates; IntlCalendar is useful for ICU calendar systems.

Practical Example: Applying the Function

This standalone example shows how the same operation fits into a small application task. The intl extension is required for this example.

<?php

$calendar = IntlCalendar::createInstance("UTC", "en_US");
$localCalendar = IntlCalendar::createInstance("Asia/Tokyo", "ja_JP");
echo $localCalendar->get(IntlCalendar::FIELD_YEAR);

The example keeps the operation visible and gives you a starting point for using it in an application. ICU calendar types and local fields are not interchangeable with Unix timestamps.

Important Behavior and Edge Cases

• Core behavior: IntlCalendar represents a locale-aware ICU calendar. Month indexes are zero-based, while epoch time uses milliseconds.
• Return value: Check the result separately from changes to passed-in arrays, iterators, or object state.
• Data constraints: ICU calendar types and local fields are not interchangeable with Unix timestamps.
• Environment: The intl extension is required for this example.

Comparison With Related Functions

Common Beginner Mistakes

Key Takeaways

• IntlCalendar::createInstance helps you create an ICU calendar for a time zone and locale.
• IntlCalendar represents a locale-aware ICU calendar. Month indexes are zero-based, while epoch time uses milliseconds.
• ICU calendar types and local fields are not interchangeable with Unix timestamps.
• DateTimeImmutable is often simpler for Gregorian dates; IntlCalendar is useful for ICU calendar systems.

IntlCalendar::createInstance is useful when you need to create an ICU calendar for a time zone and locale. Start with the small examples, then adapt the practical example while respecting its input and environment requirements.