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

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

作成日: 更新日:

基本的な使い方

parentNodeプロパティは、Dom\Documentクラスに所属する、ノードの親ノードを保持するプロパティです。 Dom\Documentオブジェクトは、XMLドキュメント全体を表すため、parentNodeプロパティは、ドキュメントの親ノード(もし存在すれば)への参照を保持します。

通常、Dom\Documentオブジェクトはドキュメントのルートノードであるため、親ノードは存在しません。したがって、parentNodeプロパティは通常nullを返します。しかし、もしドキュメントが別のノードの一部として(たとえば、別のドキュメントにインポートされた場合など)追加された場合、parentNodeプロパティはその親ノードへの参照を保持します。

parentNodeプロパティを使用することで、ドキュメントがどのようにドキュメントツリー構造に組み込まれているかを確認したり、親ノードに対して操作を行ったりすることが可能です。例えば、親ノードの属性を変更したり、別のノードを挿入したりといった操作が考えられます。

このプロパティは読み取り専用であり、値を変更することはできません。親ノードを変更するには、ノードを別の場所に挿入または移動する必要があります。parentNodeプロパティの返り値は、DOMNodeオブジェクトまたはnullのいずれかです。nullが返される場合、そのノードはドキュメントツリーのルートノードであることを意味します。このプロパティを通じて、ドキュメント構造を辿り、必要なノードにアクセスする事が可能になります。

構文(syntax)

1readonly ?DOMNode $parentNode;

引数(parameters)

戻り値(return)

Dom\Node|null

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