【PHP8.x】Dom\HTMLElement::isSameNode()メソッドの使い方

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

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

基本的な使い方

isSameNodeメソッドは、DOM (Document Object Model) において、2つのノードが同じノードであるかどうかを判定するメソッドです。Dom\HTMLElement クラスに属し、HTMLElement オブジェクトが持つメソッドとして利用できます。このメソッドは、比較対象となるノードを引数として受け取り、2つのノードが同一である場合は true を、異なる場合は false を返します。

具体的には、このメソッドはノードのアイデンティティを比較します。つまり、2つのノードがメモリ上で同じオブジェクトを指している場合にのみ true を返します。ノードの内容が同じであっても、異なるオブジェクトであれば false を返します。

システムエンジニアを目指す初心者の方にとって、isSameNodeメソッドは、DOMツリーを操作する際に、特定の要素が期待通りのものであるかを確認するのに役立ちます。例えば、イベントハンドラ内で特定の要素を操作する前に、それが正しい要素であるかどうかを検証するために使用できます。また、DOMツリーの変更を追跡する際にも、ノードが置き換えられたかどうかを判断するために利用できます。

このメソッドを使用することで、DOM操作におけるエラーを未然に防ぎ、より堅牢なWebアプリケーションを開発することができます。DOMの理解を深め、効率的なWeb開発を行う上で、isSameNodeメソッドの役割を理解しておくことは重要です。

構文(syntax)


1public Dom\HTMLElement::isSameNode(?Dom\Node $node): bool

引数(parameters)

?Dom\Node $otherNode

?Dom\Node $otherNode: 比較対象のノードを指定します。null も指定可能です。

戻り値(return)

bool

このメソッドは、指定したノードが現在のノードと同じノードであるかどうかを真偽値で返します。同じノードであれば true、そうでなければ false を返します。

サンプルコード

PHP DOMノード比較：isSameNodeで同じか判定する


1<?php
2
3/**
4 * Dom\HTMLElement::isSameNode メソッドの使用例。
5 *
6 * このメソッドは、2つのDOMノードが同じオブジェクトを指しているかどうかを比較します。
7 * PHPのDOM拡張では、同じDOMツリー内の同じノードは、たとえ異なる方法で取得されても
8 * 同じオブジェクトインスタンスとして扱われる傾向があります。
9 *
10 * キーワード「php isnotempty」との関連性:
11 * isSameNodeの戻り値はbool型です。
12 * 結果がtrue（同じノードである）またはfalse（異なるノードである）のいずれにせよ、
13 * それは有効な比較結果であり、「空ではない」意味のある情報として利用できます。
14 * ここではそのブール値を利用した条件分岐を示すことで関連付けます。
15 */
16function compareDomNodes(): void
17{
18    // 1. DOMDocument オブジェクトを作成します。
19    //    これはHTML文書全体を表現するコンテナです。
20    $dom = new DOMDocument('1.0', 'UTF-8');
21    // 出力時に整形を行うように設定します。開発時のデバッグに便利です。
22    $dom->formatOutput = true; 
23
24    // 2. ルート要素となる <html> と <body> を作成し、ドキュメントに追加します。
25    $htmlElement = $dom->createElement('html');
26    $bodyElement = $dom->createElement('body');
27    $htmlElement->appendChild($bodyElement);
28    $dom->appendChild($htmlElement);
29
30    // 3. 最初の <p> 要素を作成します。これが比較の基準となるノードです。
31    //    createElement は Dom\Element (Dom\HTMLElementを継承) のインスタンスを返します。
32    $paragraphNode1 = $dom->createElement('p', 'これは最初の段落です。');
33    $paragraphNode1->setAttribute('id', 'first-paragraph'); // 識別のためのIDを設定
34    // このノードを <body> に追加し、DOMツリーの一部とします。
35    $bodyElement->appendChild($paragraphNode1);
36
37    // 4. 二つ目の <p> 要素を作成します。内容は同じですが、全く別のオブジェクトインスタンスです。
38    //    このノードはDOMツリーには追加しません。
39    $paragraphNode2 = $dom->createElement('p', 'これは二つ目の段落です。');
40    $paragraphNode2->setAttribute('id', 'second-paragraph');
41
42    echo "--- 比較例 1: 異なるオブジェクトインスタンスの比較 ---\n";
43    // 最初の段落と二つ目の段落が同じノードであるかを比較します。
44    // createElement で作成された異なるオブジェクトは、たとえ内容やタグ名が同じでも
45    // isSameNode では `false` になります。これらは別々のメモリ上のオブジェクトだからです。
46    if ($paragraphNode1->isSameNode($paragraphNode2)) {
47        // このブロックは実行されません。
48        echo "  エラー: paragraphNode1 と paragraphNode2 は異なるインスタンスなのに同じノードと判定されました。\n";
49    } else {
50        // isSameNode が false を返した = ノードが異なる、という「空ではない」有効な情報が得られました。
51        echo "  成功: paragraphNode1 と paragraphNode2 は異なるノードです。これは予想通りの結果です。\n";
52        echo "  （理由: それぞれ個別に createElement で作成されたため、異なるオブジェクトインスタンスです。）\n";
53    }
54    echo "\n";
55
56    echo "--- 比較例 2: 同じDOMツリー内の同じノードの比較 ---\n";
57    // 5. DOMツリーから、`first-paragraph` のIDを持つノードを取得します。
58    //    getElementById は、そのIDを持つ要素の Dom\Element インスタンスを返します。
59    //    この場合、元の $paragraphNode1 と同じ実際のDOMノードインスタンスを参照します。
60    $retrievedParagraphNode = $dom->getElementById('first-paragraph');
61
62    // 取得したノードが null でないことを確認します（念のため）。
63    if ($retrievedParagraphNode === null) {
64        echo "  エラー: 'first-paragraph' のIDを持つノードが見つかりませんでした。\n";
65        return;
66    }
67
68    // 元の段落ノードと、DOMツリーから取得し直したノードを比較します。
69    // 同じDOMツリー内の同じ物理的なノードは、異なる方法で取得されても
70    // isSameNode では `true` になります。これらは同じオブジェクトインスタンスを参照しているためです。
71    if ($paragraphNode1->isSameNode($retrievedParagraphNode)) {
72        // isSameNode が true を返した = ノードが同じ、という「空ではない」有効な情報が得られました。
73        echo "  成功: paragraphNode1 と retrievedParagraphNode は同じノードです。これは予想通りの結果です。\n";
74        echo "  （理由: 両者とも DOMツリー内の同じ物理的な <p id=\"first-paragraph\"> ノードを参照しています。）\n";
75    } else {
76        // このブロックは実行されません。
77        echo "  エラー: paragraphNode1 と retrievedParagraphNode は同じノードなのに異なるノードと判定されました。\n";
78    }
79    echo "\n";
80}
81
82// 関数を実行します。
83compareDomNodes();
84

PHP 8のDom\HTMLElement::isSameNodeメソッドは、2つのDOMノードがメモリ上で全く同じオブジェクトインスタンスを指しているかどうかを比較する際に使用されます。引数$otherNodeには比較したい別のDom\Nodeオブジェクト、またはnullを指定します。メソッドは比較の結果をbool型で返し、同じオブジェクトであればtrueを、異なるオブジェクトであればfalseを返します。

このメソッドは、createElementなどで個別に作成された異なるオブジェクトインスタンスを比較した場合、たとえタグ名や内容が同じでもfalseを返します。これらはメモリ上の異なる場所にある別々のオブジェクトだからです。しかし、一度DOMツリーに追加されたノードを、その後getElementByIdのような別の方法で再度取得した場合、PHPのDOM拡張ではそれらが同じ物理的なDOMノードのオブジェクトインスタンスを参照するため、isSameNodeはtrueを返します。

キーワード「php isnotempty」との関連として、isSameNodeの戻り値であるtrueまたはfalseは、常に意味のある比較結果であり、決して「空」ではありません。このブール値を利用することで、サンプルコードのようにノードが同じか異なるかに応じた条件分岐処理を確実に実行できるため、有効な情報として利用できます。

Dom\HTMLElement::isSameNodeは、比較対象の2つのDOMノードがメモリ上で全く同じオブジェクトインスタンスであるかを判定します。同じタグ名や内容を持つノードでも、createElementなどで個別に生成された異なるオブジェクトは別物と見なされ、falseが返されます。これに対し、DOMツリーに追加されたノードをgetElementByIdなどで再度取得した場合、元のノードと取得し直したノードは同じオブジェクトインスタンスを参照するため、trueを返します。この挙動を理解し、DOMツリーにおけるノードの物理的な同一性を確認する目的で利用してください。引数にnullが渡される可能性もあるため、呼び出す前に適切なハンドリングを検討することが重要です。戻り値は比較結果を示すブール値として活用できます。

PHP Dom\HTMLElement isSameNode でノード比較する


1<?php
2
3// Dom\Document クラスを使用して新しいDOMドキュメントを作成します。
4// これはHTMLやXML構造をプログラムで操作するための土台となります。
5$document = new Dom\Document();
6
7// ドキュメントのbody要素に相当するルート要素（ここでは<div>）を作成し、ドキュメントに追加します。
8// Dom\HTMLElementはDom\Elementを継承しており、HTML要素を扱う際に使用されます。
9// createElementは通常Dom\Elementのインスタンスを返しますが、isSameNodeはDom\Nodeに定義されているため問題ありません。
10$rootElement = $document->createElement('div');
11$document->appendChild($rootElement);
12
13// 最初の段落要素 (<p>) を作成し、ルート要素に追加します。
14$elementA = $document->createElement('p');
15$elementA->textContent = 'これは最初の段落です。';
16$rootElement->appendChild($elementA);
17
18// 2番目の段落要素 (<p>) を作成し、ルート要素に追加します。
19// これはelementAとは異なるインスタンスです。
20$elementB = $document->createElement('p');
21$elementB->textContent = 'これは2番目の段落です。';
22$rootElement->appendChild($elementB);
23
24// elementAと同じオブジェクトを参照する新しい変数を作成します。
25// これは同じノードインスタンスへの別名のようなものです。
26$elementARef = $elementA;
27
28echo "--- Dom\\HTMLElement::isSameNode() メソッドの例 ---" . PHP_EOL;
29
30// シナリオ1: 同じオブジェクトを参照しているノードを比較します。
31// elementA と elementARef はメモリ上で同じノードインスタンスを指しているため、true を返します。
32echo "elementA と elementARef は同じノードですか？ ";
33var_dump($elementA->isSameNode($elementARef)); // 期待値: true
34
35// シナリオ2: 異なるオブジェクトのノードを比較します。
36// elementA と elementB は、たとえ同じタグ名や内容であったとしても、異なるノードインスタンスなので false を返します。
37echo "elementA と elementB は同じノードですか？ ";
38var_dump($elementA->isSameNode($elementB)); // 期待値: false
39
40// シナリオ3: 比較対象が null の場合。
41// isSameNodeの引数は null を許容します (?Dom\Node)。
42// null はどのノードとも同じではないため、false を返します。
43echo "elementA と null は同じノードですか？ ";
44var_dump($elementA->isSameNode(null)); // 期待値: false
45

PHPのDom\HTMLElement::isSameNode()メソッドは、HTMLやXMLなどのDOM構造をプログラムで操作する際、2つのノードがメモリ上で「全く同じオブジェクト（インスタンス）」であるかどうかを判定するために使用されます。

このメソッドの引数$otherNodeには、比較したい別のDOMノードを指定します。この引数は?Dom\Node型であり、nullを受け入れることができます。戻り値はbool型で、比較対象の2つのノードが同じインスタンスである場合にtrueを、異なるインスタンスである場合や$otherNodeがnullである場合にfalseを返します。

サンプルコードでは、まず複数のHTML要素を作成しています。$elementAと$elementARefは、同じp要素のインスタンスを参照しているため、$elementA->isSameNode($elementARef)はtrueを返します。これは、メモリ上の同じ場所にあるオブジェクトを指しているためです。一方、$elementAと$elementBは、どちらもp要素ですが、別々に作成された異なるインスタンスであるため、$elementA->isSameNode($elementB)はfalseを返します。たとえタグ名やテキスト内容が同じでも、別々のオブジェクトとして存在する場合は「同じノード」とは判断されません。また、isSameNode()にnullを渡した場合、どのノードもnullとは同じではないため、結果はfalseとなります。

Dom\HTMLElement::isSameNodeメソッドは、DOMノードがメモリ上で同一のオブジェクトインスタンスであるかを厳密に比較します。ノードの内容やタグ名が全く同じであっても、createElementなどで別々に生成されたノードは異なるインスタンスと見なされ、falseを返しますので注意が必要です。同じノードを複数の変数で参照している場合にのみtrueとなります。また、引数にnullを渡すと、どのノードとも同一ではないため必ずfalseが返ります。このメソッドは、DOMツリー内で特定のオブジェクトが本当に同じ実体であるかを正確に識別する際に活用できます。