【PHP8.x】DOMProcessingInstruction::replaceChild()メソッドの使い方

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

作成日: 2025年09月11日更新日: 2025年12月13日

基本的な使い方

『replaceChildメソッドは、特定の子ノードを新しいノードに置き換える処理を実行するメソッドです。このメソッドは、親クラスであるDOMNodeから継承された機能です。第一引数に新しく挿入するノードを指定し、第二引数に置き換えたい既存の子ノードを指定して使用します。処理が成功した場合、置き換えられて削除された古いノードを返しますが、失敗した場合はfalseを返します。しかし、DOMProcessingInstructionオブジェクトはXMLの処理命令を表すものであり、その仕様上、子ノードを持つことができません。そのため、DOMProcessingInstructionオブジェクトに対してこのメソッドを呼び出すと、ノードの階層構造に関するエラーとして必ずDOMExceptionがスローされます。したがって、このメソッドはクラスの定義上存在しますが、DOMProcessingInstructionのインスタンスで実際に使用することはできません。

構文(syntax)


1<?php
2
3$dom = new DOMDocument();
4
5// DOMProcessingInstruction, 新規ノード, 既存ノード(仮)のインスタンスを生成します
6$processingInstruction = $dom->createProcessingInstruction('target', 'data');
7$newNode = $dom->createElement('new');
8$oldNode = $dom->createElement('old');
9
10// $processingInstruction の子である $oldNode を $newNode で置き換えます。
11// 注意: DOMProcessingInstruction は子ノードを持てないため、この操作は実際には例外をスローします。
12$processingInstruction->replaceChild($newNode, $oldNode);
13
14?>

引数(parameters)

DOMNode $node, DOMNode $child

DOMNode $node: 新しい子ノードを配置する対象の既存の子ノード
DOMNode $child: 既存の子ノード ($node) を置き換える新しい子ノード

戻り値(return)

DOMNode|false

指定された子ノードを現在のノードの子ノードとして置き換えます。成功した場合は置き換えられたノード、失敗した場合はfalseを返します。

サンプルコード

PHP DOM replaceChildでノードを置き換える


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMProcessingInstructionノードを別のノードに置き換えるサンプルコード
7 *
8 * この関数は、XMLドキュメント内の処理命令ノード (DOMProcessingInstruction) を
9 * 新しく作成した要素ノード (DOMElement) に置き換える方法を示します。
10 * ノードの置き換えには、親ノードの replaceChild メソッドを使用します。
11 */
12function replaceProcessingInstructionNode(): void
13{
14    // 1. 操作対象となるXML文字列を定義します。
15    // <?php-target ... ?> が処理命令ノードです。
16    $xmlString = <<<XML
17    <?xml version="1.0" encoding="UTF-8"?>
18    <root>
19      <item id="1">First item.</item>
20      <?php-target some-data?>
21      <item id="2">Second item.</item>
22    </root>
23    XML;
24
25    // 2. DOMDocumentオブジェクトを生成し、XMLを読み込みます。
26    $dom = new DOMDocument();
27    $dom->loadXML($xmlString);
28
29    // 3. 親要素 (この場合は <root>) を取得します。
30    $rootElement = $dom->documentElement;
31
32    // 4. 置き換え対象の処理命令ノード (DOMProcessingInstruction) を探します。
33    $targetNode = null;
34    foreach ($rootElement->childNodes as $child) {
35        // ノードの型が DOMProcessingInstruction であるかを確認します。
36        if ($child instanceof DOMProcessingInstruction) {
37            $targetNode = $child;
38            break;
39        }
40    }
41
42    // 5. 処理命令ノードが見つかった場合に置き換えを実行します。
43    if ($targetNode) {
44        // 新しいノード (今回は <status>要素) を作成します。
45        $newNode = $dom->createElement('status', 'Replaced successfully.');
46
47        // 親要素の replaceChild メソッドを呼び出します。
48        // 第1引数: 新しいノード ($newNode)
49        // 第2引数: 置き換えたい既存の子ノード ($targetNode)
50        $replacedNode = $rootElement->replaceChild($newNode, $targetNode);
51
52        // $replacedNode には、取り除かれた古いノードが返されます。
53        // (このサンプルでは使用していませんが、再利用などが可能です)
54    }
55
56    // 6. 整形して、変更後のXMLを出力します。
57    $dom->formatOutput = true;
58    echo $dom->saveXML();
59}
60
61// 関数を実行します。
62replaceProcessingInstructionNode();

replaceChildメソッドは、XMLやHTMLドキュメントの親子関係において、特定の子ノードを別の新しいノードに置き換えるための機能です。このメソッドは、置き換えたいノードの親ノードに対して呼び出します。

サンプルコードでは、まずXML文字列を読み込み、<root>要素を取得しています。次に、その子ノードの中から置き換え対象である処理命令ノード<?php-target some-data?>を探し出します。対象が見つかると、新しく<status>という要素ノードを作成し、親である<root>要素のreplaceChildメソッドを実行してノードを置き換えています。

このメソッドの第1引数には新しく挿入するノードを、第2引数には置き換えたい既存の子ノードを指定します。処理が成功すると、戻り値として置き換えられて削除された古いノードが返されます。これにより、削除したノードを後で再利用することも可能です。置き換えに失敗した場合はfalseが返されます。

replaceChildメソッドは、置き換えたいノード自身からではなく、その親ノードから呼び出す点に注意してください。サンプルコードでは<root>要素が親ノードにあたります。引数の順序は replaceChild(新しいノード, 古いノード) であり、間違えやすいため注意が必要です。メソッドの戻り値は、置き換えられて取り除かれた古いノードで、操作に失敗した場合は false が返ります。また、createElementなどで作成する新しいノードは、操作対象と同じDOMDocumentオブジェクトから生成する必要があります。別のドキュメントで作成したノードは使用できません。childNodesには改行などのテキストノードも含まれるため、instanceofでノードの種類を正確に判定することが重要です。