【PHP8.x】parentElementプロパティの使い方

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

作成日: 更新日:

基本的な使い方

parentElementプロパティは、Dom\XMLDocumentクラスのインスタンスが所属する親要素へのアクセスを提供するプロパティです。このプロパティは、XMLドキュメントの構造を表現するDOM(Document Object Model)において、現在のノードの親となる要素ノードへの参照を返します。具体的には、ある要素ノードが別の要素ノードの子である場合に、その親要素(DOMElement型)を取得するために使用されます。

しかしながら、Dom\XMLDocumentクラスは、XMLドキュメント全体の最上位を表すルートノードです。XMLドキュメント自体は、他の要素の子となることはありません。そのため、Dom\XMLDocumentオブジェクトのparentElementプロパティにアクセスした場合、その値は常にnullとなります。

このプロパティは、主にツリー構造を持つXMLドキュメント内で、特定の要素ノードがどの親要素の子であるかをプログラムで確認する際に利用されます。Dom\XMLDocumentクラスにおいては、このプロパティが常にnullを返すことによって、そのドキュメントオブジェクトがツリーの最上位に位置するルートであることを示します。この機能はPHP 8.0以降で利用可能です。

構文(syntax)

1<?php
2$xmlDocument = new Dom\XMLDocument();
3$parent = $xmlDocument->parentElement;
4?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

Dom\Element|null

このプロパティは、現在のDOM要素の親要素を表すDom\Elementオブジェクト、または親要素が存在しない場合はnullを返します。

関連コンテンツ

【PHP8.x】parentElementプロパティの使い方 | いっしー@Webエンジニア