【PHP入門】HTTPコンテキストオプションの一覧と使い方を徹底解説

はじめに

PHPでは、stream_context_create() 関数で生成したコンテキストにオプションを指定することで、https:// や https:// トランスポートを使った通信の挙動を細かく制御できます。本記事では、HTTPストリームラッパーで利用可能な主なコンテキストオプションを一覧表で整理し、実際のコード例とその出力結果についてもわかりやすく解説します。

主なHTTPコンテキストオプション一覧

使用例

次のサンプルコードは、https:// のURLからヘッダー情報と本文を取得する例です。リダイレクトを追わず(max_redirects を 0 に設定)、かつエラーレスポンスでも内容を取得できるよう(ignore_errors を 1 に設定)オプションを指定しています。

<?php
// 取得対象のURL
$url = 'https://localhost/testscript.php';

// HTTPコンテキストオプションを連想配列で定義
$opts = array('http' =>
    array(
        'method' => 'GET',
        'max_redirects' => '0',
        'ignore_errors' => '1'
    )
);

// ストリームコンテキストを作成し、URLを開く
$context = stream_context_create($opts);
$stream = fopen($url, 'r', false, $context);

// メタデータを出力
var_dump(stream_get_meta_data($stream));
?>

出力結果

このコードを実行すると、以下のようにステータスライン(HTTP/1.1 200 OK)をはじめとするレスポンスヘッダー情報と、ストリームに関するメタデータが表示されます。

array(10) {
    ["timed_out"]=>
    bool(false)
    ["blocked"]=>
    bool(true)
    ["eof"]=>
    bool(false)
    ["wrapper_data"]=>
    array(7) {
        [0]=>
        string(15) "HTTP/1.1 200 OK"
        [1]=>
        string(35) "Date: Thu, 17 Sep 2020 07:04:47 GMT"
        [2]=>
        string(55) "Server: Apache/2.4.41 (Win64) OpenSSL/1.0.2s PHP/7.1.32"
        [3]=>
        string(24) "X-Powered-By: PHP/7.1.32"
        [4]=>
        string(17) "Content-Length: 0"
        [5]=>
        string(17) "Connection: close"
        [6]=>
        string(38) "Content-Type: text/html; charset=UTF-8"
    }
    ["wrapper_type"]=>
    string(4) "http"
    ["stream_type"]=>
    string(14) "tcp_socket/ssl"
    ["mode"]=>
    string(1) "r"
    ["unread_bytes"]=>
    int(0)
    ["seekable"]=>
    bool(false)
    ["uri"]=>
    string(31) "https://localhost/testscript.php"
}

出力結果の読み方のポイント

• wrapper_data には「HTTP/1.1 200 OK」で始まる生のレスポンスヘッダーが順に格納されています。サーバーソフトウェアのバージョンやContent-Typeなども確認できます。
• wrapper_type が http、stream_type が tcp_socket/ssl となっていることから、HTTPストリームラッパー経由でTCPソケット接続が確立されていることが分かります。
• timed_out や eof などの項目は、ストリームがタイムアウトしたか、終端に達したかといった状態を示すフラグです。

まとめ

HTTPコンテキストオプションを活用すれば、外部APIへのリクエスト時にUser-Agentを指定したり、タイムアウトを制御したり、プロキシ経由でのアクセスやリダイレクト回数の制限なども、cURL拡張モジュールに頼らず標準関数だけで実現できます。fopen() や file_get_contents() と組み合わせることで、柔軟で堅牢なHTTP通信処理を実装できるので、ぜひ活用してみてください。