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

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

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

基本的な使い方

removeChildメソッドは、DOMAttrクラスに属し、指定された子ノードを親ノードから削除するメソッドです。このメソッドは、HTMLやXMLドキュメントのツリー構造から、特定のノードをプログラム的に取り除くために利用されます。削除したい子ノードのオブジェクトを引数として受け取り、成功した場合には削除されたノード自身を返します。もし指定されたノードが実際の子ノードでなかった場合や、削除が不可能な状況であった場合は、エラー（DOMException）が発生する可能性があります。

しかしながら、DOMAttrクラスが表すのはHTML要素の「属性」です。例えば、<img src="image.jpg">というHTML要素のsrc="image.jpg"の部分が属性にあたります。属性ノードは、一般的なDOMツリーの概念において、自身が子ノードを持つことはありません。属性の値はテキストノードとして扱われることもありますが、これは通常、removeChildメソッドで削除するような「子ノード」とは異なる扱いです。

そのため、DOMAttrオブジェクトに対してremoveChildメソッドを呼び出すことは、通常想定される用途ではありません。DOMAttrオブジェクトが子ノードを持っていないため、このメソッドを呼び出しても、ほとんどの場合にDOMException（DOM関連のエラー）がスローされるか、期待通りの動作が得られない可能性が非常に高いです。このメソッドは、通常、<p><span>テキスト</span></p>のように実際に子ノードを持つDOMElementなどのノードに対して使用されるものです。したがって、DOMAttrオブジェクトにこのメソッドを使用することは一般的ではなく、推奨されません。

構文(syntax)


1<?php
2$domAttr = new DOMAttr('attributeName', 'attributeValue');
3$childNode = new DOMText('text content');
4
5$removedNode = $domAttr->removeChild($childNode);
6?>

引数(parameters)

DOMNode $child

DOMNode $child: 削除したい子ノードを指定するDOMNodeオブジェクト

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP DOMAttr removeChildで属性値削除


1<?php
2
3/**
4 * DOMAttr::removeChild メソッドの使用例を示します。
5 * DOMAttr は通常、属性値をテキストノードとして持ちます。
6 * この例では、DOMAttr に追加されたテキストノードを削除する方法を示します。
7 */
8function exampleRemoveChildFromDOMAttr(): void
9{
10    // 1. 新しいDOMDocumentを作成
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    $dom->formatOutput = true; // 出力を見やすく整形
13
14    // 2. ルート要素を作成し、ドキュメントに追加
15    $element = $dom->createElement('book');
16    $dom->appendChild($element);
17
18    // 3. 'isbn' という名前の属性ノードを作成
19    $attribute = $dom->createAttribute('isbn');
20
21    // 4. 属性値を表すテキストノードを作成
22    $isbnTextNode = $dom->createTextNode('978-4-06-xxxx-x');
23
24    // 5. テキストノードを属性ノードの子として追加
25    // これにより、属性ノードは子ノードを持つことになります。
26    $attribute->appendChild($isbnTextNode);
27
28    // 6. 属性ノードを要素に追加
29    $element->setAttributeNode($attribute);
30
31    echo "--- removeChild 実行前 ---\n";
32    echo $dom->saveXML() . "\n\n";
33    // 期待される出力例: <book isbn="978-4-06-xxxx-x"/>
34
35    // 7. DOMAttr オブジェクトから特定のテキストノードを削除
36    // DOMAttr::removeChild は、その属性ノードの子ノードを削除します。
37    // 通常、DOMAttr の唯一の子ノードはテキストノード（属性値）です。
38    if ($attribute->hasChildNodes()) {
39        echo "属性ノードからテキストノードを削除します...\n";
40        $removedNode = $attribute->removeChild($isbnTextNode);
41
42        echo "削除されたノードの値: " . $removedNode->nodeValue . "\n\n";
43    } else {
44        echo "属性ノードに削除する子ノードがありません。\n\n";
45    }
46
47    echo "--- removeChild 実行後 ---\n";
48    echo $dom->saveXML() . "\n";
49    // 期待される出力例: <book isbn=""/>
50    // 属性値が空になったことを確認できます。
51}
52
53// 関数の実行
54exampleRemoveChildFromDOMAttr();

DOMAttr::removeChildメソッドは、XMLやHTMLドキュメントの構造を操作するPHPのDOM拡張機能の一部です。このメソッドは、DOMAttrオブジェクトから特定の子ノードを削除するために使用されます。DOMAttrオブジェクトは、要素の属性（例: id="value" のid部分）を表し、その属性値（例: "value"）は内部的にテキストノードとして保持されることが多いです。

引数には削除したい子ノード（DOMNodeオブジェクト）を指定します。このメソッドを実行すると、指定された子ノードがDOMAttrオブジェクトから削除され、DOMツリーの構造が変更されます。PHPのDOMの一般的な挙動として、削除されたノードはメソッドの戻り値として取得できますが、元のドキュメントからは切り離されます。

サンプルコードでは、まず新しいDOMドキュメントを作成し、「book」要素に「isbn」という名前の属性ノードを追加しています。この属性ノードには、属性値を表す「978-4-06-xxxx-x」というテキストノードが子として追加され、これにより属性が値を持ちます。removeChildメソッドを実行する前は、XML出力には属性値が完全に表示されます。

その後、DOMAttrオブジェクトである$attributeから、先ほど追加したテキストノード（$isbnTextNode）をremoveChildメソッドの引数として渡して削除します。これにより、$attributeオブジェクトから属性値を表すテキストノードが取り除かれます。削除後、XML出力を見ると「isbn」属性の属性値が空になっていることが確認できます。この例は、属性値が内部的に子ノードとして扱われるDOMの概念と、それをプログラム的に操作する方法を示しています。

DOMAttr::removeChildメソッドは、指定された属性ノードからその子ノードを削除します。DOMAttrは通常、属性値を表す一つのテキストノードを子として持ちますので、このメソッドを使うとそのテキストノードが削除され、結果として属性値は空になります。引数には、削除したい子ノードを正確に指定する必要があります。子ノードが存在しない状態で呼び出すとエラーになる可能性があるため、サンプルコードのようにhasChildNodes()で事前に存在を確認することが重要です。リファレンス情報では戻り値なしと記載されていますが、PHPのDOM拡張では慣例的に削除されたノード自体が返されます。そのため、サンプルコードのように返されたノードを後続の処理で利用することが可能です。意図しないXML構造の変更を防ぐため、操作前後のXML出力で内容を確認する習慣をつけることをお勧めします。