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

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

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

基本的な使い方

replaceWithメソッドは、DOMツリー内の現在のコメントノードを、指定された新しいノードや文字列に置き換える処理を実行するメソッドです。このメソッドは、HTMLやXMLドキュメントの構造を操作する際に、特定のコメント部分の内容や位置を変更したい場合に利用されます。

replaceWithメソッドが呼び出されると、対象となるDOMCommentオブジェクトが表すコメントノードは、ドキュメントツリーから完全に削除されます。その代わり、引数として渡された一つ以上のDOMNodeオブジェクトや文字列が、元のコメントノードがあった正確な位置に順序通りに挿入されます。例えば、別の要素ノードやテキストノードを指定してコメントノードと置き換えたり、直接文字列を渡して新しいテキストノードとして挿入したりすることが可能です。

この機能は、動的にドキュメントの構造を更新する際に非常に便利で、既存のノードを削除してから新しいノードを挿入するといった手間を省き、より簡潔なコードで置き換え操作を行えます。

ただし、replaceWithメソッドが正しく動作するためには、対象となるコメントノードがすでにDOMツリーのどこかに存在し、親ノードを持っている必要があります。もしコメントノードがまだドキュメントに追加されていない状態であったり、親ノードがない場合は、このメソッドを呼び出してもドキュメントに変更は行われません。このメソッドは、PHP 8で導入されたDOM操作をより直感的に行うための便利な機能の一つです。

構文(syntax)


1$domComment->replaceWith($node1, '新しいテキスト内容', $node2);

引数(parameters)

DOMNode|string ...$nodes

DOMNode|string ...$nodes: 置換する新しいノード、またはノードに変換される文字列の可変長引数

戻り値(return)

DOMNode|false

このメソッドは、置換されたノードまたは置換操作が失敗した場合は false を返します。

サンプルコード

PHP DOM replaceWithでコメントノードを置き換える


1<?php
2
3/**
4 * DOMComment::replaceWith() を使用して、HTML内のコメントノードを
5 * 別のノードや文字列で置き換えるサンプルコードです。
6 */
7function replaceCommentNode(): void
8{
9    // 操作対象となるHTML文字列を定義
10    $html = <<<HTML
11<!DOCTYPE html>
12<html>
13<head>
14    <meta charset="UTF-8">
15    <title>DOMComment::replaceWith Example</title>
16</head>
17<body>
18    <h1>元のコンテンツ</h1>
19    <!-- このコメントを置き換えます -->
20    <p>この段落はそのままです。</p>
21</body>
22</html>
23HTML;
24
25    // DOMDocumentオブジェクトを作成し、HTMLを読み込む
26    $dom = new DOMDocument();
27    // HTMLのパースエラーを抑制
28    libxml_use_internal_errors(true);
29    $dom->loadHTML($html, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
30    libxml_clear_errors();
31
32    // DOMXPathを使用してコメントノードを検索
33    $xpath = new DOMXPath($dom);
34    // body内の最初のコメントノードを取得
35    $commentNode = $xpath->query('//body/comment()')->item(0);
36
37    // コメントノードが見つかった場合のみ処理を実行
38    if ($commentNode instanceof DOMComment) {
39        // 置き換えるための新しい要素を作成
40        $newElement = $dom->createElement('p', 'これは新しく追加された段落です。');
41        $newElement->setAttribute('class', 'highlight');
42
43        // コメントノードを新しい要素と文字列で置き換える
44        // replaceWith() は複数のノードや文字列を引数に取ることができる
45        $commentNode->replaceWith($newElement, 'そして、これは追加されたテキストです。');
46    }
47
48    // 結果のHTMLを出力
49    // 整形して出力すると、構造が分かりやすくなります
50    $dom->formatOutput = true;
51    echo $dom->saveHTML();
52}
53
54// 関数を実行
55replaceCommentNode();
56
57?>

このサンプルコードは、PHPのDOMComment::replaceWith()メソッドを使用して、HTMLドキュメント内にある特定のコメントノード（）を、別の要素や文字列で置き換える方法を示しています。

コードの処理は、まずDOMDocumentとDOMXPathを用いてHTML文字列を解析し、置き換え対象となるコメントノードを特定・取得することから始まります。次に、createElementメソッドで置き換え先となる新しい<p>要素を作成します。

中心となる$commentNode->replaceWith()メソッドは、呼び出し元であるコメントノード自身を、引数で指定したノードや文字列で完全に置き換える機能を持っています。このメソッドの引数には、DOMNodeオブジェクトや文字列を複数渡すことが可能です。サンプルでは、新しく作成した<p>要素と追加のテキスト文字列を渡しており、元のコメントがあった場所にこれらが順番に挿入されます。このメソッドは値を返しません（戻り値は void です）。

最終的に、saveHTML()で変更後のHTMLを出力します。これにより、元のコメントが指定した段落要素とテキストに置き換えられたことを確認できます。

XPathでノードを検索する際、対象が見つからない場合はnullが返るため、if文でノードの存在と型を確認する処理は重要です。replaceWithメソッドに渡す新しいノードは、必ず操作対象と同じDOMDocumentインスタンスから作成する必要があります。サンプルコードの$dom->createElement()のように、同じ$domオブジェクトから生成してください。このメソッドは複数のノードや文字列を引数に指定でき、一度にまとめて置き換えが可能です。実行後、元のコメントノードはDOMツリーから完全に削除されるため、削除されたノードに対してさらなる操作は行えない点に注意しましょう。