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

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

作成日: 更新日:

基本的な使い方

『ownerDocumentプロパティは、このコメントノードが所属するDOMDocumentオブジェクトを保持するプロパティです。PHPのDOM拡張機能では、HTMLやXML文書は、要素、テキスト、コメントといった多数のノードから構成される木構造として扱われます。DOMCommentオブジェクトは文書内のコメント部分を表し、ownerDocumentプロパティはそのコメントが含まれている文書全体を表すDOMDocumentオブジェクトへの参照を返します。このプロパティは読み取り専用であり、一度ノードが文書に所属すると、後から所属先を変更することはできません。もし、ノードが作成されただけでまだどの文書にも追加されていない場合、このプロパティの値はnullを返します。このプロパティを利用することで、特定のコメントノードを起点として、同じ文書内に新しい要素を作成するためのcreateElementメソッドを呼び出したり、文書のルート要素にアクセスしたりすることが可能になります。このように、文書内の個々の部品から文書全体へと操作を広げる際の重要な基点として機能します。』

構文(syntax)

1<?php
2
3$doc = new DOMDocument();
4
5$comment = $doc->createComment('Example comment');
6$doc->appendChild($comment);
7
8$ownerDocument = $comment->ownerDocument;
9
10var_dump($ownerDocument === $doc);
11

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMDocument|null

このプロパティは、DOMComment オブジェクトが属する DOMDocument オブジェクトを返します。ただし、コメントがドキュメントに属していない場合は null を返します。

関連コンテンツ