【PHP8.x】Dom\HTMLDocument::inputEncodingプロパティの使い方

inputEncodingプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月07日

基本的な使い方

inputEncodingプロパティは、HTMLドキュメントの入力エンコーディングを保持するプロパティです。このプロパティは、PHPのDOM拡張機能において、HTMLドキュメントをオブジェクトとして扱うためのDom\HTMLDocumentクラスに属しています。Dom\HTMLDocumentオブジェクトがウェブページやHTMLファイルから読み込まれる際に、そのドキュメントがどのような文字エンコーディング（例えばUTF-8やShift_JISなど）で記述されているかの情報がこのプロパティに自動的に設定されます。

文字エンコーディングとは、コンピュータが文字を認識し、表示するために使われる符号化方式のことであり、これが正しくないと「文字化け」と呼ばれる現象が発生してしまいます。inputEncodingプロパティは、ロードされたHTMLドキュメントがどのエンコーディングを使用しているかを開発者が確認するための手段を提供します。

このプロパティは読み取り専用であり、開発者が直接その値を変更することはできません。ドキュメントがパーサーによって解析されるときに、HTMLのメタタグやHTTPヘッダーなどから得られる情報に基づいて、最も適切と思われるエンコーディングが自動的に検出され、設定されます。

主に、取得したHTMLドキュメントの内容を別のシステムで処理する際や、特定のエンコーディングを前提とする操作を行う前に、ドキュメントの実際のエンコーディングを確認するために利用されます。例えば、データベースに保存する前に、ドキュメントの文字エンコーディングがデータベースのそれと一致するかどうかを検証するといった用途が考えられます。これにより、文字コードの不一致による予期せぬ問題を未然に防ぎ、アプリケーションの堅牢性を高めることができます。

構文(syntax)


1<?php
2
3// Dom\HTMLDocument クラスのインスタンスを生成
4$document = new Dom\HTMLDocument();
5
6// HTMLコンテンツを読み込む（例: UTF-8エンコーディングのHTML）
7$document->loadHTML('<!DOCTYPE html><html><head><meta charset="UTF-8"></head><body>PHP</body></html>');
8
9// inputEncoding プロパティにアクセスし、読み込まれた文書のエンコーディングを取得
10$inputEncoding = $document->inputEncoding;
11
12?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

HTMLドキュメントのエンコーディングを示す文字列を返します。

サンプルコード

PHP DomDocumentのinputEncodingを取得する


1<?php
2
3/**
4 * Dom\HTMLDocument::inputEncoding プロパティの使用例。
5 *
6 * このプロパティは、HTMLドキュメントがどのエンコーディングでパースされたかを示します。
7 * 主に、ドキュメント内の <meta charset="..."> タグから情報が決定されます。
8 * HTML5のパース規則に基づき、エンコーディングが明示されていない場合はUTF-8として扱われます。
9 */
10function demonstrateHtmlDocumentInputEncoding(): void
11{
12    // 1. エンコーディングが明示的に指定されたHTMLコンテンツを準備します。
13    //    <meta charset="UTF-8"> を含めることで、入力エンコーディングがUTF-8であることを示します。
14    $htmlContent = '<!DOCTYPE html>
15<html>
16<head>
17    <meta charset="UTF-8">
18    <title>サンプルページ</title>
19</head>
20<body>
21    <h1>こんにちは、世界！</h1>
22    <p>このページはUTF-8エンコーディングで書かれています。</p>
23</body>
24</html>';
25
26    // Dom\HTMLDocument オブジェクトを作成します。
27    // このクラスはPHP 8で導入され、HTML5の仕様に準拠したドキュメントを扱います。
28    $document = new Dom\HTMLDocument();
29
30    // HTML文字列をドキュメントにロードします。
31    // loadHTML() メソッドは、HTMLコンテンツをパースし、
32    // <meta charset> タグからエンコーディング情報を読み取ろうとします。
33    $document->loadHTML($htmlContent);
34
35    // inputEncoding プロパティにアクセスして、ドキュメントの入力エンコーディングを取得します。
36    // 戻り値は string 型です。
37    $encoding = $document->inputEncoding;
38
39    // 取得したエンコーディングを表示します。
40    echo "明示的にUTF-8を指定したドキュメントの入力エンコーディング: " . $encoding . "\n";
41
42    // 2. エンコーディング情報がHTML内にないコンテンツの例。
43    //    HTML5のパース規則では、エンコーディングが明示されていない場合、
44    //    デフォルトでUTF-8が入力エンコーディングとして扱われます。
45    $htmlContentWithoutCharset = '<!DOCTYPE html>
46<html>
47<head>
48    <title>別のサンプルページ</title>
49</head>
50<body>
51    <p>エンコーディングが指定されていないページです。</p>
52</body>
53</html>';
54
55    $document2 = new Dom\HTMLDocument();
56    $document2->loadHTML($htmlContentWithoutCharset);
57    $encoding2 = $document2->inputEncoding;
58
59    echo "エンコーディングが指定されていないドキュメントの入力エンコーディング: " . $encoding2 . "\n";
60}
61
62// 上記の関数を実行して、動作を確認します。
63demonstrateHtmlDocumentInputEncoding();

Dom\HTMLDocument::inputEncoding プロパティは、PHP 8で導入された Dom\HTMLDocument クラスに属し、指定されたHTMLドキュメントがどの文字エンコーディングでパース（解析）されたかを示す文字列を取得するために使用されます。

このプロパティの値は、主にHTMLドキュメント内の <meta charset="..."> タグによって決定されます。例えば、<meta charset="UTF-8"> があれば、inputEncoding は "UTF-8" を返します。HTML5のパース規則では、ドキュメント内でエンコーディングが明示的に指定されていない場合、デフォルトでUTF-8が入力エンコーディングとして扱われるため、このプロパティも通常 "UTF-8" を示します。

このプロパティに引数はなく、アクセスするだけで現在のドキュメントの入力エンコーディング名が文字列（string型）として直接返されます。例えば、Dom\HTMLDocument オブジェクトを作成し、loadHTML() メソッドでHTMLコンテンツを読み込んだ後、$document->inputEncoding のようにアクセスすることで、そのドキュメントの入力エンコーディングを簡単に確認できます。これは、ウェブページが正しいエンコーディングで処理されているかを検証したり、文字化けなどの問題をデバッグしたりする際に非常に役立ちます。

このコードはPHP 8で導入されたDom\HTMLDocumentクラスを使用しているため、PHP 7以前の環境では動作しませんのでご注意ください。inputEncodingプロパティは、HTMLドキュメントがDOMパーサーによってどのエンコーディングだと解釈されたかを示します。このエンコーディングは、主にHTMLコンテンツ内の<meta charset="...">タグから決定されます。もし<meta charset>タグが明示されていない場合でも、HTML5のパース規則に基づき、デフォルトでUTF-8が入力エンコーディングとして認識されます。このプロパティが返す値は、実際にHTMLファイルが保存されている物理的なエンコーディングとは限らず、パーサーがドキュメントを読み込んで論理的に解釈したエンコーディングである点を理解しておくことが重要です。

PHP HTMLドキュメントの入力エンコーディングを取得する


1<?php
2
3/**
4 * Dom\HTMLDocument::inputEncoding プロパティの使用方法を示すサンプルコード。
5 *
6 * この関数は、HTMLドキュメントがどのようなエンコーディングで解析されたかを
7 * どのように取得できるかを示します。システムエンジニアを目指す初心者向けに、
8 * エンコーディング情報が文字コード関連の処理にどのように役立つかを簡潔に説明します。
9 */
10function demonstrateHtmlDocumentInputEncoding(): void
11{
12    echo "--- HTMLドキュメントの入力エンコーディングの確認 ---\n\n";
13
14    // 例1: UTF-8エンコーディングが指定されたHTML文字列
15    // <meta charset=\"UTF-8\"> タグがドキュメントのエンコーディングを示します。
16    $htmlUtf8 = <<<HTML
17<!DOCTYPE html>
18<html>
19<head>
20    <meta charset="UTF-8">
21    <title>UTF-8 サンプルページ</title>
22</head>
23<body>
24    <h1>こんにちは、世界！</h1>
25    <p>このページはUTF-8で記述されています。</p>
26</body>
27</html>
28HTML;
29
30    // Dom\HTMLDocument オブジェクトを作成
31    $documentUtf8 = new Dom\HTMLDocument();
32
33    // HTML文字列をパース（解析）します。
34    // loadHTMLは、<meta charset>タグがあればその情報を元にエンコーディングを決定します。
35    $documentUtf8->loadHTML($htmlUtf8);
36
37    // inputEncoding プロパティにアクセスし、ドキュメントが解析された際のエンコーディングを取得します。
38    $encodingUtf8 = $documentUtf8->inputEncoding;
39
40    echo "UTF-8指定のHTMLをパース後の inputEncoding: " . $encodingUtf8 . "\n";
41    echo "（期待値: UTF-8）\n\n";
42
43
44    // 例2: Shift_JISエンコーディングが指定されたHTML文字列
45    // <meta charset=\"Shift_JIS\"> タグを使用します。
46    $htmlShiftJis = <<<HTML
47<!DOCTYPE html>
48<html>
49<head>
50    <meta charset="Shift_JIS">
51    <title>Shift_JIS サンプルページ</title>
52</head>
53<body>
54    <h1>こんにちは、世界！</h1>
55    <p>このページはShift_JISで記述されています。</p>
56</body>
57</html>
58HTML;
59
60    $documentShiftJis = new Dom\HTMLDocument();
61    $documentShiftJis->loadHTML($htmlShiftJis);
62    $encodingShiftJis = $documentShiftJis->inputEncoding;
63
64    echo "Shift_JIS指定のHTMLをパース後の inputEncoding: " . $encodingShiftJis . "\n";
65    echo "（期待値: Shift_JIS）\n\n";
66
67    // エンコーディング情報がなぜ重要なのかを初心者向けに説明
68    echo "--- エンコーディング情報の重要性 ---\n";
69    echo "外部から取得したHTMLやテキストデータは、様々な文字エンコーディング（文字コード）で\n";
70    echo "記述されている可能性があります。例えば、ウェブページはUTF-8が多いですが、\n";
71    echo "古いシステムではShift_JISやEUC-JPが使われていることもあります。\n";
72    echo "\n";
73    echo "`Dom\\HTMLDocument::inputEncoding` を使うと、HTMLドキュメントがどのエンコーディングで\n";
74    echo "書かれているかをプログラムで確認できます。\n";
75    echo "この情報は、文字化けを防ぐために、アプリケーションの内部処理（通常はUTF-8）と異なる\n";
76    echo "エンコーディングのデータを正しく変換（encoding_translation）する際の\n";
77    echo "出発点として非常に重要です。\n";
78}
79
80// 関数を実行し、デモンストレーションを表示します。
81demonstrateHtmlDocumentInputEncoding();
82

Dom\HTMLDocument::inputEncoding プロパティは、PHPのDOM拡張機能において、HTMLドキュメントがどの文字エンコーディング（文字コード）で解析されたかを示す文字列を返します。このプロパティは引数を取らず、解析されたエンコーディング名を文字列型で提供します。

サンプルコードでは、まずDom\HTMLDocumentオブジェクトを作成し、loadHTMLメソッドでHTML文字列をパースしています。このとき、HTML内の<meta charset="...">タグの情報をもとに、DOMパーサーがドキュメントのエンコーディングを認識します。inputEncodingプロパティにアクセスすると、この認識されたエンコーディング名（例えば「UTF-8」や「Shift_JIS」）を取得できます。

システムエンジニアを目指す初心者の方にとって、このエンコーディング情報は文字化けを防ぐ上で非常に重要です。ウェブページや外部システムから取得したHTMLデータは、作成元によって様々な文字エンコーディングで書かれている可能性があります。inputEncodingプロパティを使うことで、ドキュメントの正確なエンコーディングを確認し、必要に応じてencoding_translation（文字コード変換）を行うための出発点とすることができます。これにより、PHPアプリケーションの内部処理（多くはUTF-8）と異なるエンコーディングのデータを正しく扱い、表示や保存時の文字化けを未然に防ぐことが可能になります。

inputEncodingプロパティは、HTMLドキュメント内の<meta charset="...">タグの記述を元に、ドキュメントが解析された際のエンコーディングを返します。このタグがHTML内に存在しない場合や内容が誤っている場合、PHPが推測したエンコーディングが返されるため、必ずしも意図した通りの結果にならない可能性がある点に注意が必要です。外部から取得したHTMLデータを扱う際は、文字化けを防ぐため、このプロパティで得られたエンコーディング情報を出発点として、アプリケーションが使用する標準のエンコーディング（通常はUTF-8）へ適切に変換（encoding_translation）する処理を組み合わせることが重要です。これにより、様々な文字コードで作成されたHTMLデータを安全に処理できるようになります。