【PHP8.x】removeChildメソッドの使い方

Copy
1<?php
2
3/**
4 * DOMElement::removeChild の使用例
5 * 指定された子ノードを親ノードから削除する方法を示します。
6 */
7function demonstrateRemoveChild(): void
8{
9    // 1. 新しいDOMDocumentオブジェクトを作成
10    // XML宣言のバージョンとエンコーディングを指定します。
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    // 出力されるHTML/XMLを見やすく整形する設定
13    $dom->formatOutput = true;
14
15    // 2. ルート要素を作成し、DOMに添付
16    // 例: <root>
17    $root = $dom->createElement('root');
18    $dom->appendChild($root);
19
20    // 3. いくつかの子要素を作成し、ルート要素に追加
21    // 例: <child1>First Child</child1>
22    $child1 = $dom->createElement('child1', 'First Child');
23    $root->appendChild($child1);
24
25    // 例: <child2>Second Child</child2>
26    $child2 = $dom->createElement('child2', 'Second Child');
27    $root->appendChild($child2);
28
29    // 例: <child3>Third Child</child3>
30    $child3 = $dom->createElement('child3', 'Third Child');
31    $root->appendChild($child3);
32
33    // 4. 削除前のDOM構造を出力して確認
34    echo "--- 削除前のDOM構造 ---\n";
35    echo $dom->saveHTML();
36    echo "\n";
37
38    // 5. DOMElement::removeChild メソッドを使用して子要素を削除
39    // $root は DOMElement のインスタンスであり、その子ノードである $child2 を削除します。
40    // removeChild は削除されたノードを返します。
41    $removedNode = $root->removeChild($child2);
42
43    // 6. 削除後のDOM構造を出力して確認
44    echo "--- 削除後のDOM構造 ---\n";
45    echo $dom->saveHTML();
46    echo "\n";
47
48    // 7. 削除されたノードの情報を確認
49    echo "--- 削除されたノードの情報 ---\n";
50    echo "ノード名: " . $removedNode->nodeName . "\n";
51    echo "ノード値: " . $removedNode->nodeValue . "\n";
52}
53
54// 関数の実行
55demonstrateRemoveChild();
56
57?>

PHP 8 の DOMElement::removeChild メソッドは、XMLやHTMLなどの文書構造を表現するDOMツリーから、特定の子ノードを削除するために使用されます。このサンプルコードでは、まず新しい DOMDocument を作成し、出力を見やすく整形する設定を行った上で、ルート要素とその子要素として child1、child2、child3 を追加して初期のDOM構造を構築します。削除前のDOM構造を表示し現状を確認した後、$root->removeChild($child2) を実行します。ここで $root は親要素である DOMElement のインスタンス、引数 $child2 は親から削除したい DOMNode のインスタンスを指します。このメソッドは、指定された子ノードを親ノードから取り除き、その削除されたノード自身を DOMNode 型の戻り値として返します。返されたノードはDOMツリーからは切り離されますが、メモリ上には存在し続けるため、その情報にアクセスしたり、後で別の場所へ再挿入したりすることが可能です。削除後のDOM構造では child2 が無くなっていることを確認でき、さらに削除されたノード $removedNode の情報も表示しています。このように removeChild は、動的にDOM構造を変更する際に不可欠な機能を提供します。