【PHP8.x】DOMNode::parentElementプロパティの使い方
parentElementプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
parentElementプロパティは、現在のDOMNodeオブジェクトの親要素を保持するプロパティです。PHPのDOM拡張機能において、HTMLやXML文書の構造は、ノードと呼ばれる個々の構成要素が集まって形成される「DOMツリー」として表現されます。このプロパティは、現在操作しているノードがどの要素（HTMLタグやXMLタグ）の中に含まれているか、つまりその直上の親にあたる要素を特定するために使用されます。
取得される親要素はDOMElementオブジェクトとして返されます。しかし、常に親要素が存在するわけではありません。もし、現在のノードに親ノードが全く存在しない場合（例えば、ドキュメント全体のルート要素自体を指している場合）、または親ノードが要素ではない場合（例えば、親がDOMDocumentオブジェクトである場合など）、このプロパティはnullを返します。
このプロパティを利用することで、特定のHTML要素やXML要素から、その親要素へ効率的にアクセスし、DOMツリーを上方向に探索する処理を簡潔に記述できます。例えば、あるボタン要素の親である<div>要素を取得したい場合に役立ちます。parentElementプロパティは読み取り専用であり、現在のノードの親要素を変更する目的では使用できません。
構文(syntax)
1<?php 2$dom = new DOMDocument(); 3$dom->loadHTML('<div id="container"><span id="target">Content</span></div>'); 4 5// DOMノードを取得 6$targetNode = $dom->getElementById('target'); 7 8// parentElement プロパティを使用して親要素を取得 9$parentNode = $targetNode->parentElement; 10 11// 親要素が存在する場合、そのタグ名を表示 12if ($parentNode instanceof DOMElement) { 13 echo $parentNode->tagName; // 例: div 14} else { 15 echo "親要素は存在しないか、要素ではありません。"; 16} 17?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
?DOMElement
このプロパティは、現在のノードの親要素をDOMElementオブジェクトとして返します。親要素が存在しない場合はnullを返します。
サンプルコード
PHP DOM: parentElementで親要素を取得する
1<?php 2 3/** 4 * DOMNode::parentElement プロパティの使用方法を示すサンプルコードです。 5 * 6 * DOMNode::parentElement は、現在のノードの親要素 (DOMElement) を返します。 7 * 親が要素ではない場合や、ノードがドキュメントツリーのルートにある場合は null を返します。 8 * このプロパティは、親が必ず DOMElement であることを保証するため、DOMNode::parentNode とは異なります。 9 */ 10function demonstrateParentElement(): void 11{ 12 // 1. 解析するHTML文字列を定義します。 13 $html = <<<HTML 14 <!DOCTYPE html> 15 <html> 16 <head> 17 <title>parentElement デモ</title> 18 </head> 19 <body> 20 <div id="container"> 21 <p id="targetParagraph">これはターゲットの段落です。</p> 22 <span>別の要素</span> 23 </div> 24 </body> 25 </html> 26 HTML; 27 28 // 2. DOMDocument オブジェクトを作成し、HTMLをロードします。 29 // エラー抑制演算子 (@) は、HTML5のタグなど、古いDOMパーサで認識されないタグに対する警告を非表示にするために使用されます。 30 // 実際のアプリケーションでは、より厳密なエラーハンドリングが推奨されます。 31 $dom = new DOMDocument(); 32 @$dom->loadHTML($html); 33 34 // 3. DOMXPath オブジェクトを作成し、HTMLドキュメント内で特定の要素を検索します。 35 $xpath = new DOMXPath($dom); 36 37 // 例1: id="targetParagraph" の<p>要素を見つけ、その親要素を取得します。 38 $targetParagraph = $xpath->query("//p[@id='targetParagraph']")->item(0); 39 40 if ($targetParagraph instanceof DOMElement) { 41 echo "--- id='targetParagraph' の要素の親 ---" . PHP_EOL; 42 echo "ターゲット要素: <" . $targetParagraph->tagName . " id='" . $targetParagraph->getAttribute('id') . "'>" . PHP_EOL; 43 44 // parentElement プロパティを使用して親要素を取得します。 45 $parent = $targetParagraph->parentElement; 46 47 if ($parent instanceof DOMElement) { 48 echo "親要素: <" . $parent->tagName . " id='" . $parent->getAttribute('id') . "'>" . PHP_EOL; 49 } else { 50 echo "親要素は見つかりませんでした (null)。" . PHP_EOL; 51 } 52 echo PHP_EOL; 53 } 54 55 // 例2: id="container" の<div>要素を見つけ、その親要素を取得します。 56 $containerDiv = $xpath->query("//div[@id='container']")->item(0); 57 58 if ($containerDiv instanceof DOMElement) { 59 echo "--- id='container' の要素の親 ---" . PHP_EOL; 60 echo "ターゲット要素: <" . $containerDiv->tagName . " id='" . $containerDiv->getAttribute('id') . "'>" . PHP_EOL; 61 62 $parent = $containerDiv->parentElement; 63 64 if ($parent instanceof DOMElement) { 65 echo "親要素: <" . $parent->tagName . ">" . PHP_EOL; // <body>タグにはidがないため、tagNameのみ表示 66 } else { 67 echo "親要素は見つかりませんでした (null)。" . PHP_EOL; 68 } 69 echo PHP_EOL; 70 } 71 72 // 例3: <html>要素の親要素を取得します (これは通常 null になります)。 73 $htmlElement = $xpath->query("/html")->item(0); 74 75 if ($htmlElement instanceof DOMElement) { 76 echo "--- <html>要素の親 ---" . PHP_EOL; 77 echo "ターゲット要素: <" . $htmlElement->tagName . ">" . PHP_EOL; 78 79 $parent = $htmlElement->parentElement; 80 81 if ($parent instanceof DOMElement) { 82 echo "親要素: <" . $parent->tagName . ">" . PHP_EOL; 83 } else { 84 echo "親要素は見つかりませんでした (null)。" . PHP_EOL; 85 echo "<html>要素はドキュメントのルート要素であり、DOMElement 型の親を持ちません。" . PHP_EOL; 86 } 87 echo PHP_EOL; 88 } 89} 90 91// 関数を実行してデモを表示します。 92demonstrateParentElement();
PHP 8のDOMNode::parentElementプロパティは、HTMLやXMLドキュメント内で特定のノードが持つ「親要素」を取得するために使用されます。このプロパティに引数は不要です。
戻り値としては、現在のノードの親がDOMElement型（例えば<div>や<p>といったHTMLタグ）である場合に、その親要素のDOMElementオブジェクトを返します。もし親ノードが要素ではない場合（例えば、ドキュメント自体が親となる場合など）や、現在のノードがドキュメントツリーの最上位にある場合は、nullが返されます。
似たプロパティにDOMNode::parentNodeがありますが、parentElementは親が必ずDOMElement型であることを保証するという違いがあります。これにより、HTMLの要素構造をたどる際に、常に親が要素として扱えるため便利です。
サンプルコードでは、まず<p>要素の親として<div>要素を取得しています。次に、その<div>要素の親として<body>要素を取得する例を示しています。さらに、<html>要素のようにドキュメントのルートにある要素にはDOMElement型の親が存在しないため、parentElementプロパティはnullを返すことが確認できます。このように、このプロパティは、Webページの構造を解析する際に、階層を上方向にたどって特定の親要素を見つけたい場合に役立ちます。
DOMNode::parentElementは、現在のノードの親が要素である場合にのみDOMElementを返します。親がドキュメントのルート要素であったり、要素ではない場合はnullになりますので、取得後は必ずnullチェックを行い、その後の処理を適切に分岐させてください。これを怠ると、nullに対してプロパティやメソッドを呼び出そうとして実行時エラーの原因となります。DOMNode::parentNodeとは異なり、parentElementは常にDOMElement型、またはnullを返す点が特徴です。また、サンプルコードにある@エラー抑制演算子は警告を非表示にするものですが、実務ではエラーを適切に処理するコードを書くべきであり、安易な使用は避けるべきです。DOMXPath::query()の結果も、要素が見つからない場合はitem(0)がnullとなるため、利用前にその存在や型を確認することが重要です。
PHP DOM: parentElementで親要素を取得する
1<?php 2 3/** 4 * DOMNode::parentElement プロパティの使用例を示す関数。 5 * 6 * この関数はHTML文字列からDOMツリーを構築し、特定の子要素の親要素を取得・表示します。 7 * システムエンジニアを目指す初心者でもDOMツリーの探索方法を理解できるよう、 8 * DOMNode::parentElement の基本的な使い方に焦点を当てています。 9 */ 10function demonstrateParentElement(): void 11{ 12 // DOMDocumentのインスタンスを作成 13 $dom = new DOMDocument(); 14 15 // 解析するHTMLコンテンツを定義 16 $htmlContent = <<<HTML 17<!DOCTYPE html> 18<html> 19<head> 20 <title>DOM parentElement Example</title> 21</head> 22<body> 23 <div id="container"> 24 <p>これはサンプル段落です。</p> 25 <span>別の要素です。</span> 26 </div> 27</body> 28</html> 29HTML; 30 31 // HTML文字列をDOMDocumentにロード 32 // @ を付けてエラー抑制していますが、実際の開発では適切なエラーハンドリングを推奨します。 33 @$dom->loadHTML($htmlContent); 34 35 // すべての <p> 要素を取得 36 // getElementsByTagName は DOMNodeList オブジェクトを返します 37 $paragraphs = $dom->getElementsByTagName('p'); 38 39 // 最初の <p> 要素が存在する場合のみ処理を実行 40 if ($paragraphs->length > 0) { 41 /** @var DOMElement $firstParagraph DOMElement型にキャストし、プロパティの補完を可能にする */ 42 $firstParagraph = $paragraphs->item(0); 43 44 // DOMNode::parentElement プロパティを使用して、現在のノードの親要素を取得 45 // 戻り値は ?DOMElement (DOMElement または null) です 46 $parent = $firstParagraph->parentElement; 47 48 if ($parent !== null) { 49 echo "最初の <p> 要素の親要素はタグ名 '{$parent->tagName}' です。\n"; 50 echo "親要素のID属性は '{$parent->getAttribute('id')}' です。\n"; 51 } else { 52 // 親が要素でない場合（例: DOMDocument自体が親の場合など） 53 echo "最初の <p> 要素には要素である親がありませんでした。\n"; 54 } 55 } else { 56 echo "HTML内に <p> 要素が見つかりませんでした。\n"; 57 } 58 59 echo "\n--- ルート要素の親要素の確認 ---\n"; 60 // <html> 要素の親要素を取得する例 61 $htmlElements = $dom->getElementsByTagName('html'); 62 if ($htmlElements->length > 0) { 63 /** @var DOMElement $htmlElement */ 64 $htmlElement = $htmlElements->item(0); 65 $parentOfHtml = $htmlElement->parentElement; // <html> の親は DOMDocument であり、DOMElementではないため null になる 66 67 if ($parentOfHtml !== null) { 68 echo "<html> 要素の親要素はタグ名 '{$parentOfHtml->tagName}' です。\n"; 69 } else { 70 echo "<html> 要素の親はDOMElementではありません（通常、DOMDocument自体が親）。\n"; 71 } 72 } 73} 74 75// 関数を実行してサンプルコードの動作を確認 76demonstrateParentElement();
PHP 8のDOMNode::parentElementは、特定のDOMノードの親要素を取得するためのプロパティです。これはDOMNodeクラスに属し、現在のノードから見て直接の上位にある「要素」（HTMLタグ）を返します。このプロパティに引数は不要です。
戻り値は?DOMElement型で、親がHTML要素であればDOMElementオブジェクトを返します。しかし、もし親が要素ではない場合（例えば、DOMツリーのルートであるDOMDocumentオブジェクトが親の場合など）はnullを返します。
サンプルコードでは、まずHTML文字列をDOMDocumentに読み込み、DOMツリーを構築しています。次に、getElementsByTagName('p')で<p>タグの要素をすべて取得し、その最初の<p>要素を選択します。そして、この<p>要素に対してparentElementプロパティを使用し、親要素を取得しています。取得した親要素（この例では<div>タグ）のタグ名やID属性を表示することで、親要素が正しく特定されていることを確認できます。
また、<html>要素のように、その親がDOMDocumentである場合にはparentElementはnullを返します。これは、DOMDocument自体はHTML要素ではないためです。このプロパティを利用することで、HTMLやXMLの構造をプログラムで効率的に探索し、操作することが可能になります。
DOMNode::parentElementは、親要素が存在しない場合や、親がDOMElement型でない場合にnullを返します。そのため、取得した結果がnullでないかを常に確認してから利用するようにしてください。サンプルコードのようにnullチェックを行うことで、プログラムが安全に動作します。
また、DOMDocument::loadHTMLでHTMLの解析エラーが発生する可能性や、getElementsByTagNameで目的の要素が見つからない可能性もあります。これらの操作では、@によるエラー抑制ではなく、エラーハンドリングや要素の存在チェックを適切に行うことが、より信頼性の高いコードを書く上で重要です。特に初心者のうちは、これらのチェックを怠らないようにしましょう。