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

Copy
1<?php
2
3/**
4 * DOM要素から指定した子ノードを削除するサンプル関数です。
5 */
6function removeChildNodeExample(): void
7{
8    // 1. DOMDocumentオブジェクトを作成します
9    $dom = new DOMDocument('1.0', 'UTF-8');
10    // 出力を整形する設定を有効にします
11    $dom->formatOutput = true;
12
13    // 2. 操作対象のXML文字列を読み込みます
14    $xmlString = <<<XML
15    <bookstore>
16      <book category="COOKING">
17        <title lang="en">Everyday Italian</title>
18        <author>Giada De Laurentiis</author>
19        <year>2005</year>
20        <price>30.00</price>
21        <note>This note will be removed.</note>
22      </book>
23      <book category="WEB">
24        <title lang="en">Learning XML</title>
25        <author>Erik T. Ray</author>
26        <year>2003</year>
27        <price>39.95</price>
28      </book>
29    </bookstore>
30    XML;
31    $dom->loadXML($xmlString);
32
33    // 3. 親ノードを取得します (ここでは最初の<book>要素)
34    $bookElement = $dom->getElementsByTagName('book')->item(0);
35
36    // 4. 削除対象の子ノードを取得します (最初の<book>要素内の<note>要素)
37    $noteElement = $dom->getElementsByTagName('note')->item(0);
38
39    echo "--- 削除前のXML ---" . PHP_EOL;
40    echo $dom->saveXML();
41    echo PHP_EOL;
42
43    // 5. 親ノードから子ノードを削除します
44    // removeChildメソッドは、削除に成功した場合、削除したノード自体を返します。
45    if ($bookElement && $noteElement) {
46        $removedNode = $bookElement->removeChild($noteElement);
47
48        echo "--- 削除後のXML ---" . PHP_EOL;
49        echo $dom->saveXML();
50        echo PHP_EOL;
51
52        echo "--- 削除されたノード情報 ---" . PHP_EOL;
53        // 戻り値として受け取った削除済みノードの情報を確認できます
54        echo "削除されたノード名: " . $removedNode->nodeName . PHP_EOL; // "note"
55        echo "削除されたノードの値: " . $removedNode->nodeValue . PHP_EOL; // "This note will be removed."
56    }
57}
58
59// 関数を実行します
60removeChildNodeExample();

DOMNode::removeChildは、DOMツリー構造において、特定の親ノードからその直接の子であるノードを削除するためのメソッドです。このメソッドは、子ノードを削除したい親ノードのオブジェクトに対して呼び出します。

引数には、削除対象となる子ノードのオブジェクトを指定します。指定したノードがその親ノードの子でない場合は、処理は失敗します。

処理が成功すると、removeChildメソッドは削除された子ノードオブジェクトそのものを返します。これにより、削除後もそのノードが持っていた情報（タグ名やテキスト内容など）にアクセスすることが可能です。

サンプルコードでは、まずXMLデータを読み込み、最初の<book>要素を親ノードとして取得しています。次に、その子である<note>要素を取得し、$bookElement->removeChild($noteElement)を呼び出すことで<note>要素を削除しています。実行結果では、削除前のXMLには存在した<note>要素が、削除後のXMLではなくなっていることが確認できます。さらに、戻り値として受け取った削除済みノードの情報を利用して、そのノード名と値を出力しています。