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

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

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

基本的な使い方

characterSetプロパティは、Dom\Documentクラスが扱うHTMLやXMLドキュメントの文字エンコーディング情報を保持するプロパティです。このプロパティは、ドキュメントの内容がどのような文字セット（例えば、UTF-8やShift_JISなど）で符号化されているかを示します。

Dom\DocumentオブジェクトがHTMLやXMLファイルを読み込んだり、文字列からパースしたりする際に、そのドキュメント内で指定されている文字エンコーディング情報（例えば、HTMLの<meta charset="...">タグやXMLの<?xml ... encoding="..."?>宣言など）を自動的に解釈し、このcharacterSetプロパティに格納します。そのため、このプロパティは基本的に読み取り専用であり、外部から値を設定して変更することはできません。

このプロパティを参照することで、現在操作しているドキュメントがどの文字エンコーディングを使用しているかを確認できます。これは、例えばドキュメントの内容をデータベースに保存する際や、外部のAPIに送信する際、あるいは他のシステムと連携して文字化けを防ぐ必要がある場合に非常に役立ちます。取得される値は、"UTF-8"や"EUC-JP"といった標準的なエンコーディング名を示す文字列です。DOM操作を行う上で、文字エンコーディングの正しい理解と利用は、文字化けやデータ破損といった問題を避けるために重要ですので、このプロパティで正確な情報を確認することをお勧めします。

構文(syntax)


1<?php
2$document = new Dom\Document();
3$document->loadHTML('<!DOCTYPE html><html><head><meta charset="UTF-8"></head><body></body></html>');
4echo $document->characterSet;

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このプロパティは、DOMドキュメントの文字エンコーディングを表す文字列を返します。

サンプルコード

PHP Dom\Document::characterSet で文字コードを取得する


1<?php
2
3/**
4 * Dom\Document クラスの characterSet プロパティの使用方法を示すサンプルコードです。
5 * このプロパティは、HTML ドキュメントや XML ドキュメントの文字エンコーディングを
6 * 取得するために使用されます。
7 *
8 * @return void
9 */
10function demonstrateDomCharacterSet(): void
11{
12    // 1. 解析するHTML文字列を準備します。
13    // ここでは、<meta charset="UTF-8"> タグで文字エンコーディングを明示的に指定しています。
14    $htmlContent = '
15        <!DOCTYPE html>
16        <html lang="ja">
17        <head>
18            <meta charset="UTF-8">
19            <title>DOM Charset サンプル</title>
20        </head>
21        <body>
22            <h1>PHP Dom\Document::characterSet プロパティ</h1>
23            <p>このドキュメントは UTF-8 エンコーディングを使用しています。</p>
24        </body>
25        </html>
26    ';
27
28    // 2. Dom\Document オブジェクトを新しく作成します。
29    // このオブジェクトは、HTMLやXMLドキュメントをプログラムで操作するためのものです。
30    $dom = new Dom\Document();
31
32    // 3. 用意したHTMLコンテンツを Dom\Document オブジェクトに読み込みます。
33    // loadHTML() メソッドは、HTMLドキュメントを解析し、内部的にその文字エンコーディングを
34    // <meta charset="..."> タグから自動的に検出または推測します。
35    // エラーが発生する可能性のあるHTMLをロードする場合は、@$dom->loadHTML() のように
36    // エラー抑制演算子を使用することもありますが、今回は簡潔な例のため直接呼び出します。
37    $dom->loadHTML($htmlContent);
38
39    // 4. Dom\Document オブジェクトの characterSet プロパティにアクセスし、
40    // ドキュメントの文字エンコーディングを取得します。
41    // このプロパティは、loadHTML() が解析した結果、ドキュメントが持つと判断された
42    // エンコーディング文字列を返します。
43    $charset = $dom->characterSet;
44
45    // 5. 検出された文字エンコーディングを画面に出力します。
46    echo "HTML ドキュメントから検出された文字エンコーディング: " . $charset . PHP_EOL;
47
48    // 補足: もしHTML内に <meta charset="..."> タグがない場合、
49    // libxml（Dom\Documentが内部で利用しているライブラリ）は、
50    // 環境やコンテンツによって異なるデフォルトエンコーディング（例えば ISO-8859-1）
51    // を適用することがあります。現代のWebではUTF-8の使用が標準的です。
52}
53
54// 定義した関数を実行して、Dom\Document::characterSet プロパティの動作を確認します。
55demonstrateDomCharacterSet();
56

PHP 8 の Dom\Document::characterSet プロパティは、HTMLやXMLドキュメントの文字エンコーディング（文字コード）を取得するために使用されます。Dom\Documentクラスは、ウェブページなどのドキュメント構造をプログラムから操作するための機能を提供し、このプロパティは引数を持たず、ドキュメントのエンコーディングを示す文字列を戻り値として返します。

サンプルコードでは、まずloadHTML()メソッドを使って、<meta charset="UTF-8">と明示的に指定されたHTMLコンテンツをDom\Documentオブジェクトに読み込んでいます。このloadHTML()メソッドがドキュメントを解析する過程で、HTML内の<meta charset="...">タグなどから文字エンコーディングを自動的に検出します。ドキュメントの読み込みと解析が完了すると、$dom->characterSetとしてこのプロパティにアクセスすることで、検出された文字エンコーディング（この例では「UTF-8」）を文字列として取得することができます。これにより、プログラム上でドキュメントがどのような文字コードで書かれているかを正確に把握し、その後の処理で文字化けなどを防ぐことが可能になります。HTMLコンテンツに文字エンコーディングの指定がない場合は、内部ライブラリのデフォルト設定が適用されることがあります。

Dom\Document::characterSetプロパティは、loadHTML()で解析されたHTMLの文字エンコーディングを取得します。loadHTML()は<meta charset="...">タグを基にエンコーディングを自動検出しますが、指定がない場合はデフォルトエンコーディングが適用され、文字化けを招きます。HTMLコンテンツには常に<meta charset="UTF-8">を明示してください。また、不正なHTMLをloadHTML()で読み込むと警告が発生することがありますので、エラー処理を適切に考慮してください。

PHP DomDocument characterSetでHTMLの文字コードを取得する


1<?php
2
3/**
4 * HTML文字列からDom\Documentオブジェクトを生成し、ドキュメントの文字エンコーディングを取得します。
5 *
6 * Dom\Document::characterSet プロパティは、HTMLドキュメント内で宣言された
7 * 文字エンコーディング（<meta charset="..."> タグ）を取得するために使用されます。
8 *
9 * @param string $htmlContent HTMLコンテンツ文字列。
10 * @return string ドキュメントが宣言している文字エンコーディング。
11 */
12function getHtmlDocumentCharacterSet(string $htmlContent): string
13{
14    // PHP 8 の Dom\Document クラスのインスタンスを作成します。
15    // このクラスはHTMLやXMLをオブジェクトとして扱えるようにします。
16    $document = new Dom\Document();
17
18    // HTML文字列をドキュメントにロードします。
19    // この際、HTML内の <meta charset="..."> タグが解析され、
20    // Dom\Document オブジェクトの characterSet プロパティに設定されます。
21    $document->loadHTML($htmlContent);
22
23    // ドキュメントの characterSet プロパティから、宣言されている文字エンコーディングを取得して返します。
24    // 例えば、<meta charset="Shift_JIS"> であれば "Shift_JIS" という文字列が返されます。
25    return $document->characterSet;
26}
27
28// --- Dom\Document::characterSet プロパティの使用例 ---
29
30// キーワード「sjis」に関連付け、Shift_JISを宣言したHTMLコンテンツを用意します。
31// HTMLの<head>セクション内で <meta charset="Shift_JIS"> と指定している点に注目してください。
32$htmlShiftJisContent = <<<HTML
33<!DOCTYPE html>
34<html>
35<head>
36    <meta charset="Shift_JIS">
37    <title>Shift_JIS文字コードのサンプル</title>
38</head>
39<body>
40    <p>このドキュメントはShift_JISでエンコードされることを想定しています。</p>
41    <p>日本語のテキスト例: システム開発における文字コードの理解は重要です。</p>
42</body>
43</html>
44HTML;
45
46// 上記HTMLコンテンツを解析し、宣言されている文字エンコーディングを取得します。
47$charset = getHtmlDocumentCharacterSet($htmlShiftJisContent);
48
49// 取得された文字エンコーディングの結果を表示します。
50echo "HTMLドキュメントが宣言している文字エンコーディング: " . $charset . PHP_EOL;
51
52// 補足:
53// Dom\Document::characterSet はドキュメントが宣言しているエンコーディングを返します。
54// これは読み取り専用のプロパティです。
55// もし <meta charset="UTF-8"> のように宣言されていれば、"UTF-8" が返されます。
56

PHP 8のDom\Documentクラスは、HTMLやXMLドキュメントをプログラムで操作するための機能を提供します。その中のcharacterSetプロパティは、HTMLドキュメントが自身で宣言している文字エンコーディング（文字コード）を取得するために使用されます。具体的には、HTMLの<head>セクション内に記述される<meta charset="...">タグの値を読み取ります。

このプロパティは引数を取らず、ドキュメントから検出された文字エンコーディング名を文字列として返します。例えば、<meta charset="Shift_JIS">と宣言されたHTMLをDom\Documentオブジェクトに読み込ませると、characterSetプロパティは"Shift_JIS"という文字列を返します。サンプルコードのgetHtmlDocumentCharacterSet関数では、与えられたHTMLコンテンツをDom\Documentオブジェクトにロードし、このcharacterSetプロパティから宣言されている文字エンコーディングを取得して返しています。

$document->loadHTML($htmlContent)を実行する際に、HTML内の<meta charset="...">タグが解析され、その情報がDom\DocumentオブジェクトのcharacterSetプロパティに自動的に設定されます。これにより、開発者はドキュメントがどのような文字エンコーディングを想定しているかを簡単に確認できます。システム開発において、HTMLの文字エンコーディングを正確に把握することは、文字化けを防ぎ、データを適切に処理するために非常に重要です。このプロパティは読み取り専用で、宣言されたエンコーディングを知るために役立ちます。

Dom\Document::characterSetプロパティは、HTMLドキュメント内の<meta charset="...">タグで宣言された文字エンコーディングを読み取る専用です。この値と実際のエンコーディングが異なる場合があり、文字化けの原因となる可能性があります。ファイルがUTF-8でもHTML内でShift_JISとあればShift_JISを返します。このプロパティの値を正しく取得するためには、Dom\Document::loadHTMLメソッドでHTMLコンテンツを事前にロードしておく必要があります。