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

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

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

基本的な使い方

replaceDataメソッドは、DOMCharacterDataクラスに属し、ノードが保持する文字データの一部を置き換える操作を実行するメソッドです。DOMCharacterDataクラスは、XMLやHTMLドキュメント内でテキスト、コメント、CDATAセクションといった文字列データを保持するノードを表します。このメソッドを使用することで、これらのノードが持つ文字列データの特定の部分を、新しい文字列で効率的に更新することが可能になります。

このメソッドには三つの引数があります。一つ目の$offset引数は、文字列のどこから置き換えを開始するかを示す開始位置を整数で指定します。文字列の最初の文字は0として数えられます。二つ目の$count引数は、$offsetで指定された位置から何文字分を置き換えるかを示す文字数を整数で指定します。もし$offsetから$countで指定された範囲が元の文字列の長さを超える場合でも、$offsetから文字列の最後までが置き換えの対象となります。三つ目の$data引数は、置き換えに使用する新しい文字列を渡します。

具体的には、元の文字列の$offsetから$count文字分が削除され、その削除された位置に$dataで指定された新しい文字列が挿入されます。これにより、ノードの文字データが直接変更されます。例えば、"HelloWorld"という文字列データに対して、$offsetを5、$countを5、$dataを"World!"としてreplaceDataメソッドを実行すると、結果は"HelloWorld!"となります。

無効な$offset（負の値や文字列の長さより大きい値）や負の$countを指定した場合、またはノードが読み取り専用である場合には、エラーが発生する可能性があります。このメソッドはDOMツリー内の文字データを直接操作するため、HTMLやXMLドキュメントの内容を動的に変更する際に非常に役立ちます。

構文(syntax)


1<?php
2$node = new DOMText("original text content");
3$node->replaceData(9, 4, "data");
4?>

引数(parameters)

int $offset, int $count, string $data

int $offset: 置換を開始するオフセット（文字位置）を指定します。
int $count: 置換する文字数を指定します。
string $data: 置換する新しい文字列を指定します。

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP DOM置換：ダブルクォーテーションのテキストを書き換える


1<?php
2
3/**
4 * HTMLテキスト内の指定された要素に含まれるテキストの一部を置換します。
5 * DOMCharacterData::replaceData メソッドの使用例を示します。
6 * この関数は、最初に見つかった指定タグの最初の子DOMTextノード内で、
7 * 最初に見つかった検索文字列を新しい文字列に置換します。
8 *
9 * @param string $originalHtml 元のHTML文字列。例: '<p>こんにちは、"PHPの世界"！</p>'
10 * @param string $tagName 置換対象のテキストを含む要素のタグ名。例: 'p'
11 * @param string $searchString 置換したい文字列。この例ではダブルクォーテーションを含む文字列を想定。
12 * @param string $replaceString 置換後の新しい文字列。この例ではダブルクォーテーションを含む文字列を想定。
13 * @return string 置換後のHTML文字列。
14 * @throws Exception 指定されたタグ名または検索文字列が見つからない場合。
15 */
16function replaceDomTextData(string $originalHtml, string $tagName, string $searchString, string $replaceString): string
17{
18    $dom = new DOMDocument();
19    // HTMLをロードします。@を付けることで、不完全なHTMLに対する警告を抑制します。
20    // loadHTMLは、完全なHTMLドキュメント（<html><body>など）としてパースします。
21    @$dom->loadHTML($originalHtml);
22
23    // 指定されたタグ名の要素をすべて取得します。
24    $elements = $dom->getElementsByTagName($tagName);
25
26    if ($elements->length === 0) {
27        throw new Exception("指定されたタグ '{$tagName}' がHTML内で見つかりませんでした。");
28    }
29
30    $modified = false;
31    // 見つかったタグ要素をループします。
32    foreach ($elements as $element) {
33        // 各要素の子ノードをループし、DOMTextノードを探します。
34        foreach ($element->childNodes as $node) {
35            // ノードがDOMTextインスタンスであり、かつ検索文字列を含む場合
36            if ($node instanceof DOMText && str_contains($node->textContent, $searchString)) {
37                // DOMCharacterData::replaceData メソッドを使用してテキストを置換します。
38                // DOMTextクラスはDOMCharacterDataを継承しているため、このメソッドが利用可能です。
39                // $offset: 置換を開始する位置（0ベースのインデックス）
40                // $count: 置換する文字数
41                // $data: 新しい文字列
42                $offset = strpos($node->textContent, $searchString);
43                $count = strlen($searchString);
44
45                $node->replaceData($offset, $count, $replaceString);
46                $modified = true;
47                // 最初に見つかったものだけを置換し、ループを終了します。
48                break 2; // 外側の要素ループも終了
49            }
50        }
51    }
52
53    if (!$modified) {
54        throw new Exception("タグ '{$tagName}' 内に検索文字列 '{$searchString}' が見つかりませんでした。");
55    }
56
57    // 変更されたDOMをHTML文字列として出力します。
58    // DOMDocument::saveHTML()はドキュメント全体を保存しますが、
59    // ここでは変更された元のタグ要素の中身だけを返したいので、
60    // body要素を取得し、その子ノードを結合して返します。
61    $body = $dom->getElementsByTagName('body')->item(0);
62    $outputHtml = '';
63    if ($body) {
64        foreach ($body->childNodes as $child) {
65            $outputHtml .= $dom->saveHTML($child);
66        }
67    }
68    return $outputHtml;
69}
70
71// --- サンプルコードの実行例 ---
72
73// キーワード「php replace ダブルクォーテーション」に最も関連性の高い例です。
74// 元のテキストにはダブルクォーテーションを含む文字列があり、
75// それを別のダブルクォーテーションを含む文字列に置換します。
76$originalHtml = '<p>現在の状況は"非常に良い"です。</p>';
77$tagName = 'p'; // 置換対象のテキストを含むHTMLタグ
78$searchString = '"非常に良い"'; // 置換したい、ダブルクォーテーションを含む文字列
79$replaceString = '"改善されました"'; // 置換後の文字列もダブルクォーテーションを含む
80
81echo "元のHTML: " . htmlspecialchars($originalHtml) . PHP_EOL;
82
83try {
84    $modifiedHtml = replaceDomTextData($originalHtml, $tagName, $searchString, $replaceString);
85    echo "変更後のHTML: " . htmlspecialchars($modifiedHtml) . PHP_EOL;
86} catch (Exception $e) {
87    echo "エラー: " . $e->getMessage() . PHP_EOL;
88}
89
90// 別の例：タグ名が異なる場合
91$originalHtml2 = '<div>名前: "田中 太郎" 様</div>';
92$tagName2 = 'div';
93$searchString2 = '"田中 太郎"';
94$replaceString2 = '"佐藤 花子"';
95
96echo "\n別の元のHTML: " . htmlspecialchars($originalHtml2) . PHP_EOL;
97
98try {
99    $modifiedHtml2 = replaceDomTextData($originalHtml2, $tagName2, $searchString2, $replaceString2);
100    echo "別の変更後のHTML: " . htmlspecialchars($modifiedHtml2) . PHP_EOL;
101} catch (Exception $e) {
102    echo "エラー: " . $e->getMessage() . PHP_EOL;
103}

PHP 8のDOMCharacterData::replaceDataメソッドは、DOMツリー内のテキストデータの一部を置き換える際に使用されます。このメソッドはDOMCharacterDataクラスに属していますが、DOMTextクラスがDOMCharacterDataを継承しているため、HTML要素内のテキストノードを操作する際に利用できます。

メソッドの引数は三つあります。一つ目の$offsetは、置換を開始する位置を0から始まる整数で指定します。二つ目の$countは、$offsetから何文字を置換対象とするかを整数で指定します。三つ目の$dataは、置換後の新しい文字列データを指定します。このメソッド自体は何も戻り値を返しません。

提供されたサンプルコードでは、DOMDocumentクラスで元のHTML文字列を読み込み、指定されたタグ名（例えばpタグやdivタグ）を持つ要素を探します。次に、その要素の中からテキストノード（DOMText）を見つけ出し、置換したい文字列がそのテキストノード内に含まれているかを確認します。置換したい文字列が見つかった場合、strpos関数でその文字列が始まる位置を、strlen関数でその文字列の長さを取得し、これらをreplaceDataメソッドの$offsetと$countとして利用します。そして、新しい文字列を$dataとして渡し、テキストの一部を置換します。特に、この方法はダブルクォーテーションのような特殊文字を含む文字列の置換も、HTMLの構造を壊すことなく安全に処理できる点が特徴です。

このメソッドは、HTMLを文字列として扱うのではなく、内部的なDOMツリーのテキストデータを直接変更する点に注意が必要です。DOMDocument::loadHTMLは与えられたHTMLを完全なドキュメントとして解釈するため、元のHTMLが断片的な場合、不要なタグが付加されることがあります。結果として得られるHTMLから必要な部分だけを抽出する際は、この挙動を考慮した処理が必要です。引数の$offsetは置換開始位置、$countは置換する文字数を指し、これらが不正確だと意図しない箇所のデータが変更される可能性があります。また、サンプルコードは最初に見つかった検索文字列のみを置換しますので、複数箇所を操作したい場合はループの調整が必要です。

PHP DOM で改行を置換する


1<?php
2
3/**
4 * DOMCharacterData::replaceData を使用して、DOM テキストノード内の改行文字を置換するサンプルコード。
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * PHP の DOM 拡張機能におけるテキストデータの部分的な置換方法を簡潔に示します。
8 */
9function replaceNewlineInDomText(): void
10{
11    // 1. DOMDocument オブジェクトを作成します。
12    //    これは DOM ツリーの土台となるオブジェクトです。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14
15    // 2. 改行を含むテキストデータを持つ DOMText ノードを作成します。
16    //    DOMText ノードは DOMCharacterData を継承しており、replaceData メソッドを使用できます。
17    $originalText = "これは\n改行を含む\nサンプルテキストです。";
18    $textNode = $dom->createTextNode($originalText);
19
20    echo "--- 置換前のテキストデータ ---" . PHP_EOL;
21    echo $textNode->data . PHP_EOL . PHP_EOL;
22
23    // 3. 最初の改行文字 '\n' の位置を検索します。
24    $firstNewlineOffset = strpos($textNode->data, "\n");
25
26    if ($firstNewlineOffset !== false) {
27        // DOMCharacterData::replaceData(int $offset, int $count, string $data)
28        // - $offset: 置換を開始する位置 (0から始まる)
29        // - $count: 置換される文字数
30        // - $data: 置換する新しい文字列
31        
32        // 最初の改行文字（1文字）をスペース ' ' に置換します。
33        $textNode->replaceData($firstNewlineOffset, 1, ' ');
34        echo "最初の改行をスペースに置換しました。" . PHP_EOL . PHP_EOL;
35    } else {
36        echo "最初の改行が見つかりませんでした。" . PHP_EOL . PHP_EOL;
37    }
38
39    // 4. 再度、残りの改行文字 '\n' の位置を検索します。
40    //    前の置換で文字列の内容や長さが変わっている可能性があるため、改めて検索が必要です。
41    $secondNewlineOffset = strpos($textNode->data, "\n");
42
43    if ($secondNewlineOffset !== false) {
44        // 2番目の改行文字（1文字）を空文字列 '' (つまり削除) に置換します。
45        $textNode->replaceData($secondNewlineOffset, 1, '');
46        echo "2番目の改行を削除しました。" . PHP_EOL . PHP_EOL;
47    } else {
48        echo "2番目の改行が見つかりませんでした。" . PHP_EOL . PHP_EOL;
49    }
50
51    echo "--- 置換後のテキストデータ ---" . PHP_EOL;
52    echo $textNode->data . PHP_EOL;
53}
54
55// 関数を実行します。
56replaceNewlineInDomText();
57

PHP 8におけるDOMCharacterData::replaceDataメソッドは、XMLやHTMLのDOM（Document Object Model）ツリー内でテキストデータを操作するための強力なツールです。このメソッドは、DOMTextなどのDOMCharacterDataを継承するノードに適用され、そのノードが保持する文字列の部分的な置換を行います。

メソッドの引数として、まず$offsetで置換を開始する文字の位置を整数（0から始まる）で指定します。次に$countで、その位置から何文字を置換対象とするかを整数で指定します。最後に$dataで、置換後の新しい文字列を渡します。このメソッドは戻り値を持ちませんが、呼び出しによって対象のノードが持つテキストデータが直接変更されます。

このサンプルコードでは、まずDOMDocumentオブジェクトを作成し、そこへ改行文字を含む文字列を保持するDOMTextノードを追加します。その後、strpos関数を用いてテキスト内の最初の改行文字\nの位置を特定します。特定した$offsetと、改行文字1文字分の$count（1）を指定し、$dataにスペースを渡してreplaceDataを呼び出すことで、最初の改行をスペースに置換します。さらに、同様の手順で2番目の改行文字を探し、今度は$dataに空文字列''を渡してreplaceDataを呼び出すことで、その改行文字をテキストデータから削除しています。このように、replaceDataメソッドを使うことで、DOM内のテキストコンテンツを細かく制御し、必要に応じて文字列の一部を更新したり削除したりすることが可能です。

DOMCharacterData::replaceDataメソッドは、DOMテキストノード内の文字データを指定したオフセットから指定文字数分、新しい文字列で直接置換します。このメソッドは戻り値がないため、呼び出し後に対象のノードが変更されていることを理解しておく必要があります。特に注意すべきは、置換によってテキストの長さが変わる場合があることです。そのため、複数の置換操作を続けて行う際には、前の置換で文字列のオフセットや内容が変更されている可能性を考慮し、毎回最新のテキスト内容に基づいてオフセットを再計算することが重要です。このメソッドは低レベルな操作のため、もし全ての改行を一括で置換したい場合など、より複雑な置換にはノードのnodeValueプロパティに直接、str_replaceなどの標準文字列関数で処理した文字列を設定する方が、コードが簡潔で安全になる場合があります。文字エンコーディングの設定にも注意が必要です。