HTTP レスポンスコードを取得または設定

# http_response_code

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

http_response_code — HTTP レスポンスコードを取得または設定

### 説明

function http_response_code(int `$response_code` = 0): int|bool

HTTP レスポンスのステータスコードを取得したり設定したりします。

### パラメータ

`response_code`

  オプションの `response_code` は、レスポンスコードを設定します。

### 戻り値

`response_code` を指定した場合は、変更前に設定されていたステータスコードを返します。 `response_code` を省略した場合は、現在のステータスコードを返します。 どちらの場合でも、Web サーバー環境におけるデフォルトのステータスコードは `200` です。

`response_code` が省略されており、 かつ Web サーバー環境以外 (CLI アプリケーションなど) で実行した場合には、`false` を返します。 `response_code` を指定して、 かつ Web サーバー環境以外 (CLI アプリケーションなど) で実行した場合 (ただし、事前にレスポンスのステータスが設定されていない場合に限る) には、`true` を返します。

### 例

例1 Web サーバー環境における http_response_code() の使用例

    <?php

    // 現在のレスポンスコードを取得して、新しいコードを設定します
    var_dump(http_response_code(404));

    // 新しいレスポンスコードを取得します
    var_dump(http_response_code());
    ?>

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

    int(200)
    int(404)

例2 CLI 環境における http_response_code() の使用例

    <?php

    // 現在のデフォルトのレスポンスコードを取得します
    var_dump(http_response_code());

    // レスポンスコードを設定します
    var_dump(http_response_code(201));

    // 新しいレスポンスコードを取得します
    var_dump(http_response_code());
    ?>

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

    bool(false)
    bool(true)
    int(201)

### 参考

- header() - 生の HTTP ヘッダを送信する
- headers_list() - 送信した (もしくは送信される予定の) レスポンスヘッダの一覧を返す

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