【PHP8.x】Dom\Element::isConnectedプロパティの使い方

isConnectedプロパティの使い方について、初心者にもわかりやすく解説します。

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

基本的な使い方

『isConnectedプロパティは、その要素がドキュメントツリーに接続されているかどうかを示す真偽値（bool）を保持するプロパティです。DOM（Document Object Model）において、HTMLやXML文書は、各要素が親子関係を持つ木のような階層構造（ドキュメントツリー）で表現されます。このプロパティの値がtrueの場合、その要素がドキュメントツリーの一部として組み込まれていることを意味します。一方で値がfalseの場合は、その要素がツリーから切り離されているか、まだ一度も追加されていない独立した状態であることを示します。例えば、createElementメソッドで新しく作成されただけの要素は、まだドキュメント内のどこにも配置されていないためisConnectedはfalseを返します。その後、appendChildメソッドなどを用いてドキュメントに追加されると、このプロパティはtrueに変わります。逆に、removeChildメソッドでドキュメントから削除された要素は、再びfalseとなります。このプロパティは読み取り専用であり、ある要素が文書内に存在するかどうかを安全に確認する目的で使用されます。』

構文(syntax)


1<?php
2
3$document = new DOM\Document();
4$document->loadHTML('<!DOCTYPE html><html><body><p id="p1">Hello</p></body></html>');
5
6// ドキュメントから要素を取得する
7$element_in_doc = $document->getElementById('p1');
8
9// 新しい要素を作成する（まだドキュメントには追加されていない）
10$new_element = $document->createElement('span');
11
12// isConnected プロパティで、要素がドキュメントツリーに接続されているかを確認する
13// 接続されている場合: true
14var_dump($element_in_doc->isConnected);
15
16// 接続されていない場合: false
17var_dump($new_element->isConnected);
18
19?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

bool

Dom\Element::isConnected は、要素が DOM ツリーに接続されているかどうかを示す真偽値 (bool) を返します。true であれば接続されており、false であれば接続されていません。

サンプルコード

Dom\Element::isConnected で接続状態を確認する


1<?php
2
3/**
4 * Dom\Element::isConnected プロパティの動作を示すサンプル関数。
5 *
6 * このプロパティは、Dom\Element インスタンスが現在のドキュメントツリーに
7 * 接続されているかどうかを示す真偽値を返します。
8 * （PHP 8.2 以降で利用可能な新しい DOM 拡張機能を使用しています。）
9 */
10function demonstrateDomElementIsConnected(): void
11{
12    echo "--- Dom\\Element::isConnected プロパティのデモンストレーション ---\n\n";
13
14    // 1. 新しい Dom\Document オブジェクトを作成します。
15    //    これは、HTMLやXMLドキュメントを表すための基本オブジェクトです。
16    $document = new Dom\Document();
17
18    // 2. まだドキュメントツリーに追加されていない新しい Dom\Element を作成します。
19    //    この時点では、要素はメモリ上には存在しますが、どのドキュメントにも
20    //    属していません。
21    $unconnectedElement = $document->createElement('div');
22    $unconnectedElement->setAttribute('id', 'unconnected-div');
23    echo "新しい要素を作成しました (ID: '{$unconnectedElement->getAttribute('id')}').\n";
24    echo "この要素はまだドキュメントツリーに接続されていません。\n";
25    echo "isConnected: " . ($unconnectedElement->isConnected ? 'true' : 'false') . "\n\n"; // ここで isConnected を確認
26
27    // 3. ドキュメントに HTML コンテンツをロードします。
28    $htmlContent = '<!DOCTYPE html><html><body><p id="existing-p">これは既存の要素です。</p></body></html>';
29    $document->loadHtml($htmlContent);
30
31    // 4. ドキュメントツリーから既存の要素を取得します。
32    //    この要素は既にドキュメントの一部であるため、接続された状態です。
33    $connectedElement = $document->getElementById('existing-p');
34
35    if ($connectedElement instanceof Dom\Element) {
36        echo "ドキュメントから既存の要素を取得しました (ID: '{$connectedElement->getAttribute('id')}').\n";
37        echo "この要素はドキュメントツリーに接続されています。\n";
38        echo "isConnected: " . ($connectedElement->isConnected ? 'true' : 'false') . "\n\n"; // ここで isConnected を確認
39    } else {
40        echo "指定されたID ('existing-p') の要素が見つかりませんでした。デモンストレーションを続行できません。\n\n";
41        return;
42    }
43
44    // 5. 以前作成した、接続されていない要素をドキュメントに追加します。
45    //    要素がドキュメントツリーに追加されると、isConnected の値が変化します。
46    $body = $document->getElementsByTagName('body')->item(0);
47    if ($body instanceof Dom\Element) {
48        $body->appendChild($unconnectedElement);
49        echo "以前作成した要素をドキュメントの<body>タグに追加しました。\n";
50        echo "要素追加後 (ID: '{$unconnectedElement->getAttribute('id')}') の isConnected: " . ($unconnectedElement->isConnected ? 'true' : 'false') . "\n\n"; // 追加後の isConnected を確認
51    } else {
52        echo "ドキュメントの<body>タグが見つかりませんでした。要素の追加をスキップします。\n\n";
53    }
54    
55    echo "--- デモンストレーション終了 ---\n";
56}
57
58// 関数を実行して、Dom\Element::isConnected の動作を確認します。
59demonstrateDomElementIsConnected();

PHPのDom\Element::isConnectedプロパティは、PHP 8.2以降で利用できる機能です。このプロパティは、Dom\Elementオブジェクトが現在のHTMLやXMLドキュメントツリーに実際に接続されているかどうかを示す真偽値（bool）を返します。引数はとりません。

サンプルコードは、このプロパティの動作を段階的に示しています。まず、Dom\Elementオブジェクトを単独で作成した直後、まだどのドキュメントにも追加されていない状態では、isConnectedはfalseを返します。これは、要素がメモリ上には存在するものの、文書の一部としては扱われていないことを意味します。次に、既存のHTMLコンテンツから取得した要素は、すでにドキュメントツリーに属しているため、isConnectedはtrueを返します。最後に、単独で作成した要素をappendChildメソッドを使ってドキュメントツリーに追加すると、その要素のisConnectedプロパティの値はtrueに変化します。このプロパティは、DOM操作を行う際に、要素が正しく文書構造に組み込まれているかを確認するために非常に役立ちます。

このサンプルコードは、DOM要素がドキュメントツリーに「接続されているか」を判定するDom\Element::isConnectedプロパティの動作を示しています。まず、このプロパティはPHP 8.2以降の新しいDOM拡張機能で利用可能であるため、実行環境のPHPバージョンを確認してください。要素はcreateElementで作成された直後ではまだツリーに接続されておらずfalseを返しますが、appendChildなどでドキュメントツリーに追加されるとtrueに変わります。既存のドキュメントから取得した要素は通常trueです。DOM操作で要素を取得する際は、対象が存在しない可能性を考慮し、必ず要素の型を確認（例: instanceof Dom\Element）して未取得時のエラーを防ぐようにしてください。要素のライフサイクルにおける接続状態を正しく理解し、安全なDOM操作を心がけましょう。

Dom\Element::isConnectedで接続状態を確認する


1<?php
2
3/**
4 * Dom\Element::isConnected プロパティの動作を示す関数。
5 *
6 * このプロパティは、DOM要素が現在ドキュメントツリーに接続されているか（文書の一部であるか）を
7 * 真偽値 (bool) で返します。
8 * 要素が親ノードを持つか、またはDom\Documentに直接アペンドされている場合に true を返します。
9 * キーワード "paho connection lost" はネットワーク接続の喪失に関するものですが、
10 * Dom\Element::isConnected はHTML/XMLドキュメントの内部構造における要素の「接続」状態を
11 * 示すため、直接的な関連性はありません。
12 * ここでは、Dom\Element::isConnected の正確な動作を初心者向けに示します。
13 */
14function demonstrateElementConnectionStatus(): void
15{
16    // 1. 新しいDom\Documentインスタンスを作成します。
17    // これはHTMLやXMLドキュメントの全体を表すオブジェクトです。
18    $document = new Dom\Document();
19    echo "--- Dom\Document を作成しました ---\n";
20
21    // 2. 新しいDom\Elementインスタンス（例: <div>要素）を作成します。
22    // この時点では、要素はまだどのドキュメントにも追加されていません。
23    $element = new Dom\Element('div');
24    $element->setAttribute('id', 'myNewElement');
25    echo "Dom\Element 'div#myNewElement' を作成しました。\n";
26
27    // 3. 作成直後の要素の接続状態を確認します。
28    // まだドキュメントツリーに追加されていないため、isConnected は false です。
29    echo "作成直後の要素の接続状態: " . ($element->isConnected ? 'true' : 'false') . "\n"; // => false
30
31    // 4. 要素をDom\Documentに追加します。
32    // これにより、要素はドキュメントツリーの一部となり「接続」されます。
33    $document->appendChild($element);
34    echo "\n--- 要素をドキュメントに追加しました ---\n";
35
36    // 5. ドキュメントに追加された後の要素の接続状態を確認します。
37    // ドキュメントツリーに接続されたため、isConnected は true です。
38    echo "ドキュメント追加後の要素の接続状態: " . ($element->isConnected ? 'true' : 'false') . "\n"; // => true
39
40    // 6. 要素をドキュメントから削除します。
41    // Dom\Document::removeChild() を使って親ノードから子ノードを取り除きます。
42    // これにより、要素はドキュメントツリーから切り離されます。
43    $document->removeChild($element);
44    echo "\n--- 要素をドキュメントから削除しました ---\n";
45
46    // 7. ドキュメントから削除された後の要素の接続状態を確認します。
47    // ドキュメントツリーから切り離されたため、isConnected は再び false です。
48    echo "ドキュメント削除後の要素の接続状態: " . ($element->isConnected ? 'true' : 'false') . "\n"; // => false
49
50    echo "\n--- デモンストレーション終了 ---\n";
51}
52
53// 関数を実行して、Dom\Element::isConnected の動作を確認します。
54demonstrateElementConnectionStatus();

Dom\Element::isConnectedプロパティは、PHPのDOM操作において、特定の要素（Dom\Elementインスタンス）が現在HTMLやXMLのドキュメントツリーに接続されているか、すなわち文書構造の一部として存在するかを判定するために使用されます。このプロパティは引数を取らず、要素がドキュメントツリーに接続されていればtrueを、接続されていなければfalseという真偽値を返します。

サンプルコードでは、まず新しいDom\Elementを作成し、この時点ではドキュメントツリーに接続されていないため、isConnectedはfalseを返します。その後、作成した要素をDom\Documentに追加すると、要素はドキュメントツリーの一部となり、isConnectedはtrueに変化します。さらに、その要素をドキュメントから削除すると、ドキュメントツリーから切り離されるため、isConnectedは再びfalseに戻ります。このように、要素が実際に文書構造に組み込まれているか否かを正確に判断することが可能です。

なお、提示されたキーワード「paho connection lost」はネットワーク接続の喪失を指しますが、Dom\Element::isConnectedはHTML/XMLドキュメントの内部構造における要素の「接続」状態を示すため、直接的な関連性はありません。このプロパティは、Webページなどのドキュメント構造を動的に操作する際に、要素が有効な位置にあるかを確認するのに役立ちます。

Dom\Element::isConnectedプロパティは、HTMLやXMLなどの文書ツリー内で、その要素が現在接続されているかを示すものです。ネットワーク接続の喪失（キーワードのpaho connection lostなど）とは全く関係ありませんので、混同しないようご注意ください。

新しい要素を作成した直後は、まだどのドキュメントにも追加されていないため、isConnectedはfalseを返します。この要素をDom\DocumentインスタンスにappendChildなどで追加すると、文書ツリーに「接続」され、trueに変わります。逆に、removeChildなどでドキュメントから要素を削除すると、再びfalseに戻ります。このプロパティは、動的にDOM要素を操作する際に、特定の要素が現在ドキュメントの一部として有効であるかを安全に確認するために利用できます。