新しい DateTimeImmutable オブジェクトを返す

# DateTimeImmutable::__construct

# date_create_immutable

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

DateTimeImmutable::__construct -- date_create_immutable — 新しい DateTimeImmutable オブジェクトを返す

### 説明

オブジェクト指向型

public function DateTimeImmutable::__construct(string `$datetime` = "now", ?DateTimeZone `$timezone` = `null`)

手続き型

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

新しい DateTimeImmutable オブジェクトを返します。

### パラメータ

`datetime`

  日付/時刻 文字列。有効な書式については 日付と時刻の書式 で説明しています。

  ここに `"now"` を指定して `$timezone` パラメータを使うと、現在時刻を取得できます。

`timezone`

  `$datetime` のタイムゾーンを表す DateTimeZone オブジェクト。

  `$timezone` を省略した場合、 または `null` の場合、 現在のタイムゾーンを使います。

  > 注意:

  > `$datetime` パラメータが UNIX タイムスタンプ (`@946684800` など) であったりタイムゾーン付きで指定した場合 (`2010-01-28T15:00:00+02:00` や `2010-07-05T06:00:00Z` など) は、 `$timezone` パラメータや現在のタイムゾーンは無視されます。

### 戻り値

新しい DateTimeImmutable のインスタンスを返します。

### エラー / 例外

無効な日付/時刻の文字列が渡された場合、 DateMalformedStringException がスローされます。 PHP 8.3 より前のバージョンでは、 Exception がスローされていました。

### 変更履歴

バージョン | 説明
--- | ---
8.3.0 | 無効な文字列が渡された場合、 Exception ではなく DateMalformedStringException がスローされるようになりました。
7.1.0 | マイクロ秒が '00000' ではなく、実際の値で埋められるようになりました。

### 例

例1 DateTimeImmutable::__construct() の例

オブジェクト指向型

    <?php
    try {
        $date = new DateTimeImmutable('2000-01-01');
    } catch (Exception $e) {
        echo $e->getMessage();
        exit(1);
    }

    echo $date->format('Y-m-d');

上の例の出力は以下となります。

    2000-01-01

手続き型

    <?php
    $date = date_create('2000-01-01');
    if (!$date) {
        $e = date_get_last_errors();
        foreach ($e['errors'] as $error) {
            echo "$error\n";
        }
        exit(1);
    }

    echo date_format($date, 'Y-m-d');

上の例の出力は以下となります。

    2000-01-01

例2 DateTimeImmutable::__construct() の複雑な例

    <?php
    date_default_timezone_set('America/Jamaica');

    // PHP のデフォルトのタイムゾーンでの日時の指定
    $date = new DateTimeImmutable('2000-01-01');
    echo $date->format('Y-m-d H:i:sP') . "\n";

    // 指定したタイムゾーンでの日時の指定
    $date = new DateTimeImmutable('2000-01-01', new DateTimeZone('Pacific/Nauru'));
    echo $date->format('Y-m-d H:i:sP') . "\n";

    // PHP のデフォルトのタイムゾーンでの現在日時
    $date = new DateTimeImmutable();
    echo $date->format('Y-m-d H:i:sP') . "\n";

    // 指定したタイムゾーンでの現在日時
    $date = new DateTimeImmutable('now', new DateTimeZone('Pacific/Nauru'));
    echo $date->format('Y-m-d H:i:sP') . "\n";

    // UNIX タイムスタンプの使用例。結果のタイムゾーンは UTC となることに注意しましょう。
    $date = new DateTimeImmutable('@946684800');
    echo $date->format('Y-m-d H:i:sP') . "\n";

    // 存在しない値は繰り上がります
    $date = new DateTimeImmutable('2000-02-30');
    echo $date->format('Y-m-d H:i:sP') . "\n";

上の例の出力は、 たとえば以下のようになります。

    2000-01-01 00:00:00-05:00
    2000-01-01 00:00:00+12:00
    2010-04-24 10:24:16-04:00
    2010-04-25 02:24:16+12:00
    2000-01-01 00:00:00+00:00
    2000-03-01 00:00:00-05:00

> 注意:

> 繰り上がった日付は、 DateTimeImmutable::getLastErrors() の警告をチェックすることで検知できます。

例3 関連付けられたタイムゾーンを変更する

    <?php
    $timeZone = new \DateTimeZone('Asia/Tokyo');

    $time = new \DateTimeImmutable();
    $time = $time->setTimezone($timeZone);

    echo $time->format('Y/m/d H:i:s e'), "\n";

上の例の出力は、 たとえば以下のようになります。

    2022/08/12 23:49:23 Asia/Tokyo

例4 相対日付/時刻 の文字列を使う

    <?php
    $time = new \DateTimeImmutable("-1 year");

    echo $time->format('Y/m/d H:i:s'), "\n";

上の例の出力は、 たとえば以下のようになります。

    2021/08/12 15:43:51

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open