【PHP8.x】mb_http_input関数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * mb_http_input() の使用例を示します。
7 *
8 * この関数はHTTPリクエストの入力文字エンコーディングを取得します。
9 * Webサーバー環境で実行されることを想定した関数です。
10 *
11 * @see https://www.php.net/manual/ja/function.mb-http-input.php
12 */
13function showHttpInputEncodingExample(): void
14{
15    /*
16     * 重要: mb_http_input() は PHP 8.0.0 で非推奨 (deprecated) になりました。
17     * この関数が依存していた php.ini ディレクティブ `mbstring.http_input` は削除されており、
18     * 現代のPHP環境では意図通りに動作しない可能性があります。
19     * このサンプルは、関数の歴史的な使い方を理解するために提供されています。
20     */
21
22    // 引数を指定しない場合、設定されている入力エンコーディングを取得します。
23    // コマンドラインで実行した場合や、設定がない場合は false を返すことがあります。
24    echo '現在の入力エンコーディング:' . PHP_EOL;
25    $currentInputEncoding = mb_http_input();
26    var_dump($currentInputEncoding);
27    echo PHP_EOL;
28
29    // 引数に 'I' (全て) を指定すると、
30    // GET, POST, COOKIE 等の入力タイプごとのエンコーディングを配列で取得します。
31    echo '全ての入力タイプのエンコーディング:' . PHP_EOL;
32    $allInputEncodings = mb_http_input('I');
33    var_dump($allInputEncodings);
34    echo PHP_EOL;
35
36    // 現代のPHPでは、$_GET や $_POST などのスーパーグローバル変数を直接扱い、
37    // 必要に応じて mb_convert_encoding() などで文字エンコーディングを
38    // 明示的に変換する方法が一般的です。
39}
40
41// 関数を実行して結果を表示します。
42showHttpInputEncodingExample();
43

mb_http_input()は、Webサーバーが受け取ったHTTPリクエストの入力文字エンコーディングを取得するための関数です。しかし、この関数はPHP 8.0.0で非推奨となりました。関連する設定がPHPから削除されたため、現代の環境では意図通りに動作しない可能性がある点に注意が必要です。この説明は、関数の歴史的な役割を理解するためのものとしてご覧ください。

引数を指定せずにこの関数を呼び出すと、設定されている入力エンコーディング名を文字列として返します。設定がない場合や、Webサーバー以外の環境で実行した場合はfalseを返すことがあります。引数に特定の文字（例: 'I'）を渡すと、GET、POST、COOKIEといった入力ソースごとのエンコーディングを配列形式で取得できます。

戻り値は、取得したエンコーディング名の文字列、エンコーディング名の配列、または取得に失敗した場合のfalseのいずれかです。

現代のPHP開発では、この関数に頼るのではなく、$_GETや$_POSTなどのスーパーグローバル変数を直接扱い、mb_convert_encoding()関数などを用いて明示的に文字エンコーディングを変換する方法が一般的です。