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

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

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

基本的な使い方

characterSetプロパティは、Dom\HTMLDocumentオブジェクトが表すHTMLドキュメントの文字エンコーディング情報を保持するプロパティです。このプロパティは、WebページなどのHTMLドキュメントがどのような文字セット（例: "UTF-8"、"Shift_JIS"など）で記述されているかを示す文字列を格納しています。

HTMLドキュメントの文字エンコーディングは、そのドキュメント内のテキストデータがどのように符号化されているかを定義します。例えば、「あ」という文字がコンピューター上でどのように表現されるかを決めるものであり、この情報が正しくないと文字化けが発生する原因となります。

Dom\HTMLDocumentオブジェクトがHTMLドキュメントを解析する際、このプロパティはドキュメントの<meta charset="...">タグやHTTPレスポンスヘッダなどから自動的にエンコーディングを検出し、その標準的な名前を文字列として提供します。システムエンジニアとしてHTMLコンテンツを処理する際には、取得したHTMLの文字セットを正確に把握することが非常に重要です。このプロパティを参照することで、HTMLドキュメントがどのエンコーディングで作成されているかを確認でき、それに応じて適切な文字コード変換処理を行う判断材料にすることができます。

このプロパティは読み取り専用であるため、ドキュメントの文字エンコーディングを直接変更することはできませんが、ロードされたドキュメントの情報を正確に取得し、文字化けのない安全なデータ処理を実現するための基本的な手段となります。

構文(syntax)


1<?php
2
3$document = new Dom\HTMLDocument();
4// ドキュメントの文字エンコーディングを取得します。
5$characterSet = $document->characterSet;

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

Dom\HTMLDocument クラスの characterSet プロパティは、HTML ドキュメントの文字エンコーディングを示す文字列を返します。

サンプルコード

PHP 8: HTML文字セットを取得する


1<?php
2
3// Dom\HTMLDocument クラスを使用してHTMLドキュメントの文字セットを取得する関数
4function getHtmlDocumentCharacterSet(string $htmlContent): string
5{
6    // Dom\HTMLDocument オブジェクトを新しく作成します
7    $document = new Dom\HTMLDocument();
8
9    // 提供されたHTMLコンテンツをドキュメントにロードします
10    // HTML内の<meta charset="...">タグに基づいて文字セットを決定します
11    $document->loadHTML($htmlContent);
12
13    // ドキュメントの characterSet プロパティにアクセスし、文字セットを取得して返します
14    return $document->characterSet;
15}
16
17// サンプルHTMLコンテンツ (UTF-8エンコーディングを指定)
18$sampleHtmlUtf8 = '<!DOCTYPE html>
19<html>
20<head>
21    <meta charset="UTF-8">
22    <title>サンプルページ</title>
23</head>
24<body>
25    <h1>こんにちは、PHP 8！</h1>
26</body>
27</html>';
28
29// サンプルHTMLコンテンツ (Shift_JISエンコーディングを指定)
30$sampleHtmlShiftJis = '<!DOCTYPE html>
31<html>
32<head>
33    <meta charset="Shift_JIS">
34    <title>サンプルページ</title>
35</head>
36<body>
37    <h1>こんにちは、PHP 8！</h1>
38</body>
39</html>';
40
41// UTF-8エンコーディングのHTMLから文字セットを取得し表示
42echo "UTF-8 HTML の文字セット: " . getHtmlDocumentCharacterSet($sampleHtmlUtf8) . PHP_EOL;
43
44// Shift_JISエンコーディングのHTMLから文字セットを取得し表示
45echo "Shift_JIS HTML の文字セット: " . getHtmlDocumentCharacterSet($sampleHtmlShiftJis) . PHP_EOL;
46
47?>

PHP 8のDom\HTMLDocument::characterSetプロパティは、HTMLドキュメントの文字セット情報を取得するためのものです。このプロパティはDom\HTMLDocumentクラスに属しており、読み込んだHTMLドキュメントがどの文字セットで書かれているかを文字列で返します。

このプロパティを利用するには、まずDom\HTMLDocumentオブジェクトを新しく作成します。次に、そのオブジェクトのloadHTML()メソッドを使って、処理したいHTMLコンテンツを読み込ませます。HTMLコンテンツがロードされると、ドキュメント内に含まれる<meta charset="...">タグなどの情報に基づき、文字セットが自動的に決定されます。

characterSetプロパティには引数を与える必要はありません。プロパティに直接アクセスすることで、決定された文字セットの名称（例えば "UTF-8" や "Shift_JIS" など）が文字列として戻り値として得られます。

サンプルコードでは、Dom\HTMLDocumentを使用してHTML文字列を解析し、そのcharacterSetプロパティから文字セットを取得する関数を定義しています。UTF-8とShift_JIS、それぞれの文字セットを指定したHTMLコンテンツを関数に渡すことで、正しく「UTF-8」と「Shift_JIS」という文字セットが取得される様子が示されており、HTMLドキュメントの文字セットをプログラムで確認する際に非常に役立ちます。

このcharacterSetプロパティは、Dom\HTMLDocument::loadHTML()メソッドでHTMLコンテンツを読み込んだ際に、HTML内の<meta charset="...">タグから自動的に決定されます。したがって、HTMLコンテンツに正しいcharset指定がない場合や、指定と実際のエンコーディングが異なる場合は、意図しない文字セットが取得される可能性がありますのでご注意ください。PHP環境でDOM拡張が有効になっていることを確認してください。また、loadHTMLはHTMLのパースに失敗すると警告を出すことがありますので、実際の運用ではエラーハンドリングを検討することが推奨されます。

PHP Dom HTML文字コード取得


1<?php
2
3/**
4 * Dom\HTMLDocument クラスの characterSet プロパティの使用例です。
5 * HTMLドキュメントが自身で宣言している文字エンコーディングを取得する方法を示します。
6 * キーワード: php charset sjis
7 */
8function demonstrateHtmlDocumentCharacterSetProperty(): void
9{
10    // Shift_JISを宣言するHTML文字列を定義します。
11    // HTML内の <meta charset="Shift_JIS"> タグに注目してください。
12    $htmlContentSjis = <<<HTML
13<!DOCTYPE html>
14<html lang="ja">
15<head>
16    <meta charset="Shift_JIS">
17    <title>サンプルページ</title>
18</head>
19<body>
20    <h1>文字エンコーディングの確認</h1>
21    <p>このHTMLはShift_JISとして扱われることを意図しています。</p>
22</body>
23</html>
24HTML;
25
26    // Dom\HTMLDocument オブジェクトを作成し、上記のHTMLコンテンツをロードします。
27    // 第三引数の 'Shift_JIS' は、入力されたHTML文字列がShift_JISエンコーディングであることを
28    // パーサーに明示的に伝えます。
29    $documentSjis = new Dom\HTMLDocument($htmlContentSjis, 'text/html', 'Shift_JIS');
30
31    // characterSet プロパティを使用して、HTMLドキュメントが自身で宣言している
32    // 文字エンコーディングを取得します。この値は通常、<meta charset="..."> タグから検出されます。
33    $declaredCharset = $documentSjis->characterSet;
34
35    // 取得した文字エンコーディングを出力します。
36    echo "HTMLドキュメントが宣言している文字エンコーディング: " . $declaredCharset . PHP_EOL;
37}
38
39// 関数を実行します。
40demonstrateHtmlDocumentCharacterSetProperty();

PHP 8のDom\HTMLDocumentクラスに属するcharacterSetプロパティは、HTMLドキュメントが自身で宣言している文字エンコーディング（文字コード）を取得するために使用されます。このプロパティは引数を取らず、戻り値として検出された文字エンコーディングの名前を文字列で返します。通常、HTMLコンテンツ内の<meta charset="...">タグからその値が検出されます。

サンプルコードでは、<meta charset="Shift_JIS">タグを持つHTML文字列を定義しています。このHTML文字列をDom\HTMLDocumentオブジェクトにロードする際、入力データのエンコーディングがShift_JISであることを明示的に指定しています。これにより、ドキュメントが正しく解析されます。その後、$documentSjis->characterSetプロパティにアクセスすることで、HTMLドキュメントが宣言している文字エンコーディング「Shift_JIS」を取得し、その結果を画面に出力しています。

このプロパティを利用することで、プログラムからHTMLの文字エンコーディング情報を正確に把握でき、特に複数の文字コード（例えばphp charset sjisなど）が混在するウェブシステムでデータを扱う際に、文字化けを防ぐための適切な処理を行う上で重要な役割を果たします。

このサンプルコードでは、Dom\HTMLDocumentコンストラクタの第三引数とcharacterSetプロパティの役割を正しく理解することが重要です。コンストラクタの第三引数は、入力するHTML文字列そのもののエンコーディングを指定し、パーサーに正しく解析させるための指示です。一方、characterSetプロパティは、解析されたHTMLドキュメント内で<meta charset="...">タグなどにより宣言されているエンコーディングを返します。

もし第三引数に指定したエンコーディングが、実際のHTML文字列のエンコーディングと異なると、HTMLが正しく解析されず、characterSetが期待通りの値を返さない可能性があります。

また、サンプルではShift_JISを扱っていますが、現代のWeb開発ではUTF-8が主流です。Shift_JISのようなマルチバイト文字を扱う際は、文字化けを防ぐためにエンコーディングの指定や変換を特に慎重に行ってください。常にHTMLのエンコーディングとPHPスクリプトのエンコーディングの一貫性を保つことが大切です。