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

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

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

基本的な使い方

removeChildメソッドは、DOM (Document Object Model) の XMLDocument クラスに属するメソッドで、指定された子ノードを親ノードから削除するために使用されます。XMLDocument は、XML ドキュメント全体を表すクラスであり、removeChildメソッドは、そのドキュメント内の特定の要素を取り除く操作を提供します。

具体的には、removeChildメソッドは引数として削除したい子ノードを受け取ります。この子ノードは、XMLDocument オブジェクトが表すドキュメントの構造内で、直接の子要素である必要があります。メソッドが正常に実行されると、指定された子ノードがドキュメントから削除され、ドキュメントの構造が更新されます。removeChildメソッドは、削除されたノードを返します。削除に失敗した場合、例えば指定されたノードが親ノードの子ノードでない場合、予期しない結果になる可能性があります。

removeChildメソッドは、XML ドキュメントの動的な変更において重要な役割を果たします。例えば、ユーザーの操作に応じてドキュメントの内容を更新したり、不要になった要素を削除したりする場合に利用できます。システムエンジニアは、このメソッドを利用することで、XML データを効率的に管理し、アプリケーションの要件に合わせて柔軟にドキュメント構造を操作することができます。XML ドキュメントの構造を理解し、removeChildメソッドを適切に使用することで、安全かつ効率的な XML データ処理を実現できます。

構文(syntax)


1<?php
2
3namespace Dom;
4
5class XMLDocument
6{
7    /**
8     * @param \DOMNode $oldnode
9     *
10     * @return \DOMNode|false
11     */
12    public function removeChild(\DOMNode $oldnode)
13    {
14    }
15}

引数(parameters)

Dom\Node $child

Dom\Node $child: 削除する子ノードを指定します

戻り値(return)

Dom\Node

引数で指定された子ノードが削除された場合、その削除された子ノード自身を返します。

サンプルコード

PHP DOM removeChildで子ノードを削除する


1<?php
2
3/**
4 * Dom\XMLDocument::removeChild を使用してXMLの子ノードを削除するサンプル
5 *
6 * この関数は、指定されたXML文字列から特定の要素を削除し、
7 * 削除されたノードと変更後のXML全体を出力します。
8 */
9function removeNodeExample(): void
10{
11    // 操作対象となるXML文字列
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<bookstore>
15  <book category="COOKING">
16    <title lang="en">Everyday Italian</title>
17    <author>Giada De Laurentiis</author>
18  </book>
19  <book category="CHILDREN">
20    <title lang="en">Harry Potter</title>
21    <author>J. K. Rowling</author>
22  </book>
23  <book category="WEB">
24    <title lang="en">Learning XML</title>
25    <author>Erik T. Ray</author>
26  </book>
27</bookstore>
28XML;
29
30    // Dom\XMLDocumentオブジェクトを作成
31    $dom = new Dom\XMLDocument();
32
33    // XML文字列を読み込む
34    $dom->loadXML($xmlString);
35
36    // ルート要素 (<bookstore>) を取得
37    $root = $dom->documentElement;
38
39    // 削除対象のノードを取得 (ここでは2番目の<book>要素)
40    // getElementsByTagNameはDom\NodeListを返す
41    $books = $root->getElementsByTagName('book');
42    $childToRemove = $books->item(1); // 0から始まるインデックスで指定
43
44    // 親ノードからremoveChild()を呼び出し、子ノードを削除する
45    // メソッドは成功した場合、削除されたノードを返す
46    if ($childToRemove !== null) {
47        $removedNode = $root->removeChild($childToRemove);
48
49        // 削除されたノードの情報を確認
50        echo "--- 削除されたノード ---" . PHP_EOL;
51        echo $dom->saveXML($removedNode);
52        echo PHP_EOL;
53    }
54
55    // 出力を整形するために設定
56    $dom->preserveWhiteSpace = false;
57    $dom->formatOutput = true;
58
59    // 変更後のXML全体を出力して確認
60    echo "--- 変更後のXML ---" . PHP_EOL;
61    echo $dom->saveXML();
62}
63
64// サンプル関数を実行
65removeNodeExample();
66
67?>

Dom\XMLDocument::removeChildは、DOMツリー構造において、親ノードから指定した子ノードを削除するためのメソッドです。

このサンプルコードは、まずloadXMLメソッドを使ってXML形式の文字列を読み込み、DOMオブジェクトを生成します。次に、getElementsByTagNameとitem(1)を用いて、削除対象となる2番目の<book>要素を取得します。そして、その親ノードであるルート要素（<bookstore>）に対してremoveChildメソッドを呼び出し、引数に先ほど取得した<book>要素を渡すことで、DOMツリーからそのノードを削除しています。

このメソッドの引数には、削除対象となる子ノード（Dom\Nodeオブジェクト）を指定します。処理が成功すると、戻り値として削除されたノードそのものが返されます。サンプルでは、この戻り値を変数$removedNodeに格納し、どのノードが削除されたかを確認のために出力しています。最後にsaveXMLメソッドで変更が反映されたXML全体を出力することで、指定したノードが完全に削除されていることが確認できます。

removeChildメソッドは、子ノードを削除するために、その直接の親ノードから呼び出す必要があります。ドキュメントオブジェクト全体から呼び出すのではない点に注意してください。サンプルコードでは、親である<bookstore>要素（$root）から子である<book>要素を削除しています。また、getElementsByTagNameで取得した要素リストから特定の要素を選ぶ際は、item()メソッドのインデックスが0から始まることを忘れないようにしましょう。削除対象のノードが存在しない場合にエラーが発生するのを防ぐため、処理の前にnullチェックを行うと、より安全なコードになります。このメソッドは削除したノード自体を返すため、何が削除されたかを確認できます。