【PHP8.x】Dom\HTMLDocument::saveXml()メソッドの使い方

saveXmlメソッドの使い方について、初心者にもわかりやすく解説します。

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

基本的な使い方

saveXmlメソッドは、Dom\HTMLDocumentクラスに属するメソッドで、DOMドキュメントをXML文字列として保存するために使用されます。このメソッドは、ドキュメント全体または指定されたノードをXML形式の文字列にシリアライズ（直列化）し、その結果を返します。

具体的には、HTMLドキュメントの構造（要素、属性、テキストなど）をXMLの形式で表現した文字列を生成します。この際、XML宣言（<?xml version="1.0"?>）や文字エンコーディング（charset）の情報も含まれる場合があります。

saveXmlメソッドは、引数としてオプションでノードを指定できます。ノードを指定した場合、そのノードの子孫ノードのみがXML文字列として保存されます。ノードが指定されない場合、ドキュメント全体が保存されます。

このメソッドは、ドキュメントの内容をファイルに保存するのではなく、単に文字列として取得する点がsaveメソッド（ファイルに書き込む）と異なります。取得したXML文字列は、例えばデータベースに格納したり、ネットワーク経由で送信したり、他のプログラムで処理したりする用途に利用できます。

また、saveXmlメソッドは、整形式（well-formed）なXMLを生成することを保証します。これは、XMLの構文規則に従っていることを意味し、これにより、他のXMLパーサーで正しく解析できるようになります。

システムエンジニアを目指す初心者の方は、このメソッドを利用することで、HTMLドキュメントをプログラムで扱いやすいXML形式に変換し、様々な処理に応用できることを理解しておくと良いでしょう。

構文(syntax)


1Dom\HTMLDocument::saveXml(?string $filename = null, int $options = 0): string|false

引数(parameters)

?\Dom\Node $node = null, int $options = 0

?\Dom\Node $node = null: 保存するDOMノード。省略するとドキュメント全体が保存されます。
int $options = 0: 保存時のオプションを指定する整数。

戻り値(return)

string|false

HTMLドキュメント全体をXML形式の文字列として取得します。処理に失敗した場合はfalseを返します。

サンプルコード

PHP Dom saveXmlでXMLを出力する


1<?php
2
3// Dom\HTMLDocument::saveXml メソッドの使用例
4// PHP 8 以降で利用可能な Dom\HTMLDocument クラスを使用します。
5
6use Dom\HTMLDocument; // Dom\HTMLDocument クラスをインポートします。
7
8/**
9 * Dom\HTMLDocument クラスの saveXml メソッドの基本的な使い方を示す関数。
10 * HTMLドキュメント全体、または特定のノードをXML文字列として出力します。
11 */
12function demonstrateSaveXml(): void
13{
14    // 1. 新しい HTMLDocument オブジェクトを作成します。
15    $document = new HTMLDocument();
16
17    // 2. サンプル HTML コンテンツをロードします。
18    // loadHTML メソッドは、指定されたHTML文字列をパースし、DOMツリーを構築します。
19    $html_content = <<<HTML
20<!DOCTYPE html>
21<html>
22<head>
23    <meta charset="utf-8">
24    <title>サンプルドキュメント</title>
25</head>
26<body>
27    <h1>こんにちは、DOMの世界！</h1>
28    <p>これは <strong>重要な</strong> 段落です。</p>
29</body>
30</html>
31HTML;
32    $document->loadHTML($html_content);
33
34    // 3. ドキュメント全体の XML を出力します。
35    // saveXml() を引数なしで呼び出すと、ドキュメント全体がXML文字列として出力されます。
36    // 戻り値は成功時に string、失敗時に false です。
37    echo "--- ドキュメント全体の XML 出力 ---\n";
38    $full_xml = $document->saveXml();
39
40    if ($full_xml !== false) {
41        echo $full_xml;
42    } else {
43        echo "ドキュメント全体の XML 生成に失敗しました。\n";
44    }
45    echo "\n\n";
46
47    // 4. 特定のノード (h1) の XML を出力します。
48    // getElementsByTagName を使用して、最初の 'h1' タグノードを取得します。
49    $h1_elements = $document->getElementsByTagName('h1');
50    if ($h1_elements->count() > 0) {
51        $h1_node = $h1_elements->item(0); // 最初の 'h1' ノードを取得します。
52
53        echo "--- 特定のノード (h1) の XML 出力 ---\n";
54        // 特定のノード ($h1_node) を引数に指定して saveXml() を呼び出すと、
55        // そのノードとその子ノードを含むXMLが生成されます。
56        $h1_xml = $document->saveXml($h1_node);
57
58        if ($h1_xml !== false) {
59            echo $h1_xml;
60        } else {
61            echo "h1 ノードの XML 生成に失敗しました。\n";
62        }
63    } else {
64        echo "h1 タグが見つかりませんでした。\n";
65    }
66    echo "\n";
67}
68
69// サンプル関数を実行します。
70demonstrateSaveXml();
71
72?>

PHP 8以降で利用できるDom\HTMLDocument::saveXmlメソッドは、HTMLドキュメント、またはそのドキュメント内の特定の要素（ノード）をXML形式の文字列として出力するために使用されます。このメソッドはDom\HTMLDocumentクラスのインスタンスから呼び出されます。

引数に何も指定せずsaveXml()と呼び出すと、現在ロードされているHTMLドキュメント全体のXML表現が文字列として返されます。これにより、HTMLドキュメントの完全な構造をXMLとして取得できます。

また、$node引数に特定のDom\Nodeオブジェクト（例えば<h1>タグのノードなど）を指定すると、その指定されたノードと、それに含まれる子ノードのみを含むXML文字列が生成されます。これは、ドキュメントの一部だけを抜き出して処理したい場合に特に便利です。$options引数はXML出力に関する詳細な設定に利用されますが、通常はデフォルトで問題ありません。

このメソッドは、XML文字列の生成に成功した場合にその文字列を返します。もし、何らかの理由でXMLの生成に失敗した場合は、戻り値としてfalseが返されます。そのため、メソッドの実行結果がfalseでないかを確認することで、エラーを適切に処理できます。

Dom\HTMLDocument::saveXml メソッドを使用する際は、いくつか注意点があります。まず、戻り値が成功時に文字列、失敗時に false となるため、必ず if ($result !== false) のように処理の成否を確認してください。次に、このメソッドはHTMLとして解釈された内容をXML形式で出力します。そのため、HTML特有のタグ省略などがXMLの閉じタグ付きの形式 (<br/> など) に変換される点を理解しておく必要があります。引数を指定しない場合、ドキュメント全体のXMLが出力されますが、特定のノードオブジェクトを引数に渡すと、そのノードとその子ノードを含むXMLのみを抽出できます。また、この Dom\HTMLDocument クラスはPHP 8以降で利用できるため、古いバージョンのPHP環境では動作しません。コードの冒頭で use Dom\HTMLDocument; と名前空間を宣言することも忘れないでください。

PHP DomDocument::saveXML で整形XMLを出力する


1<?php
2
3// Dom\HTMLDocument の saveXML メソッドのサンプルコード
4// 指定されたノードまたはドキュメント全体をXMLとして保存します。
5// pretty オプションを使用して、整形されたXMLを出力します。
6
7$dom = new DOMDocument('1.0', 'UTF-8');
8$dom->preserveWhiteSpace = false;
9$dom->formatOutput = true; // prettyオプションの代替
10
11// ルート要素を作成
12$root = $dom->createElement('root');
13$dom->appendChild($root);
14
15// 子要素を作成
16$child = $dom->createElement('child');
17$child->textContent = 'Hello, World!';
18$root->appendChild($child);
19
20// XMLとして保存
21$xmlString = $dom->saveXML();
22
23if ($xmlString) {
24    echo $xmlString . PHP_EOL;
25} else {
26    echo "XMLの保存に失敗しました。" . PHP_EOL;
27}
28
29// 特定のノードを保存する場合
30$dom2 = new DOMDocument();
31$dom2->loadHTML('<!DOCTYPE html><html><body><h1>Hello</h1><p>World</p></body></html>');
32$body = $dom2->getElementsByTagName('body')->item(0);
33
34if ($body) {
35    $bodyXml = $dom2->saveXML($body);
36    echo $bodyXml . PHP_EOL;
37} else {
38    echo "Body要素が見つかりませんでした。" . PHP_EOL;
39}
40
41?>

PHPのDom\HTMLDocumentクラスのsaveXMLメソッドは、指定されたノード、またはドキュメント全体をXML形式の文字列として保存するために使用します。引数 $node には、保存したいノードを指定します。省略した場合は、ドキュメント全体が保存されます。$options はオプションのフラグで、XMLの保存形式を制御できますが、このサンプルコードでは使用していません。saveXMLメソッドは、XML形式の文字列を返し、保存に失敗した場合は false を返します。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、ルート要素と子要素を追加して簡単なXMLドキュメントを構築しています。$dom->formatOutput = true; は、prettyオプションと同様に、XMLを整形して見やすく出力するための設定です。saveXML() を呼び出すことで、構築したXMLドキュメントが文字列として $xmlString に格納されます。

次に、HTMLドキュメントから特定のノード（body要素）を抽出し、そのノードのみをXMLとして保存する例を示しています。$dom2->saveXML($body) のように、引数にノードを指定することで、ドキュメント全体ではなく、特定の要素だけをXMLとして保存できます。

saveXMLメソッドを使用することで、DOMドキュメントやその一部を簡単にXML形式の文字列に変換し、ファイルへの書き出しやデータベースへの保存など、様々な用途に利用できます。XMLの構造をプログラムで操作し、その結果をXML形式で出力したい場合に非常に便利なメソッドです。

Dom\HTMLDocument::saveXML()メソッドは、XML形式の文字列を生成します。引数にノードを指定すると、そのノード以下をXMLとして出力します。ノードがnullの場合は、ドキュメント全体が出力されます。戻り値は文字列または失敗時にfalseです。

prettyオプションは直接指定できませんが、DOMDocumentクラスのformatOutputプロパティをtrueに設定することで、整形されたXMLを出力できます。

saveXML()は、HTMLドキュメントをXMLとして扱うため、HTMLの構造によっては予期しない結果になることがあります。特定のノードを保存する場合は、ノードが存在するかどうかを事前に確認しましょう。また、文字エンコーディングにも注意し、UTF-8を使用することを推奨します。XMLの保存に失敗した場合は、エラーメッセージを確認し、原因を特定してください。

PHP DomDocument::saveXml でXML出力する


1<?php
2
3/**
4 * Dom\HTMLDocument::saveXml メソッドの使用方法を示すサンプルコードです。
5 * HTMLドキュメントをロードし、その内容をXML形式の文字列として出力します。
6 * UTF-8エンコーディングを明示するために、HTMLコンテンツにメタタグを含めています。
7 */
8function demonstrateSaveXml(): void
9{
10    // 1. Dom\HTMLDocument オブジェクトを作成します。
11    //    このオブジェクトは、HTMLドキュメントをDOMツリーとして表現するために使用されます。
12    $document = new Dom\HTMLDocument();
13
14    // 2. UTF-8エンコードされたサンプルHTMLコンテンツを用意します。
15    //    <meta charset="UTF-8"> を含めることで、ドキュメントがUTF-8エンコーディングであることを明示し、
16    //    多言語文字が正しく扱われるようにします。
17    $htmlContent = <<<'HTML'
18<!DOCTYPE html>
19<html>
20<head>
21    <meta charset="UTF-8">
22    <title>サンプルページ</title>
23</head>
24<body>
25    <h1>こんにちは、世界！</h1>
26    <p>これは Dom\HTMLDocument::saveXml のサンプルです。</p>
27    <p>多言語文字の例: 日本語 (こんにちは), 中国語 (你好), ロシア語 (Привет).</p>
28</body>
29</html>
30HTML;
31
32    // 3. 用意したHTMLコンテンツをDom\HTMLDocumentにロードします。
33    //    loadHTMLメソッドは、HTML文字列を解析し、DOMツリーを構築します。
34    $document->loadHTML($htmlContent);
35
36    // 4. ドキュメント全体をXML形式の文字列として保存（取得）します。
37    //    saveXmlメソッドは、現在のDOMツリーをXML形式の文字列として返します。
38    //    引数を指定しない場合（null）、ドキュメント全体が保存されます。
39    //    オプションもデフォルト値(0)を使用します。
40    //    戻り値は成功時に string、失敗時に false です。
41    $xmlString = $document->saveXml();
42
43    // 5. 結果を出力します。
44    if ($xmlString !== false) {
45        echo "--- DOMツリーをXML形式で出力 (UTF-8) ---\n";
46        echo $xmlString;
47        echo "\n-----------------------------------------\n";
48    } else {
49        echo "エラー: XMLの保存に失敗しました。\n";
50    }
51}
52
53// サンプル関数を実行します。
54demonstrateSaveXml();

PHPのDom\HTMLDocument::saveXmlメソッドは、HTMLドキュメントのDOMツリーをXML形式の文字列として取得するために利用されます。このメソッドは、Dom\HTMLDocumentオブジェクトにロードされたHTMLコンテンツを解析し、その構造をXMLのテキストデータとして出力します。

サンプルコードでは、まずDom\HTMLDocumentのインスタンスを作成し、loadHTMLメソッドを使ってHTML文字列をロードしています。このHTMLには<meta charset="UTF-8">が含まれており、日本語などの多言語文字が適切にエンコードされ、正しくXMLとして出力されることを保証しています。saveXmlメソッドが呼ばれると、ロードされたHTMLドキュメント全体のDOMツリーがXML形式の文字列として生成されます。

saveXmlメソッドの引数として、$nodeには特定のDOMノードを指定してそのノード以下のみをXML化できますが、省略（null）した場合はドキュメント全体が出力されます。また、$optionsではXMLの出力に関する詳細な設定を行えますが、サンプルではデフォルト値が使用されています。メソッドの戻り値は、処理が成功した場合にはXML形式の文字列、失敗した場合にはfalseとなります。このように、HTMLをXMLとして扱いたい場合や、DOMツリーの構造を確認する際に便利なメソッドです。

Dom\HTMLDocument::saveXmlメソッドは、処理が成功した場合にXML文字列を、失敗した場合はfalseを返します。そのため、戻り値を必ず確認し、適切なエラーハンドリングを行うことが重要です。サンプルコードのように多言語文字を扱う場合は、HTMLコンテンツに<meta charset="UTF-8">タグを明記することで、文字化けを防ぎ、UTF-8エンコードされたXMLが正しく出力されるようになります。この機能を利用するには、PHPにDOM拡張モジュールが有効になっている必要がありますので、事前に環境を確認してください。HTMLドキュメントをXML形式で保存するため、HTMLの柔軟な記述がXMLの厳格な規則に沿って解釈される点にも注意が必要です。