Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】DOMDocument::documentElementプロパティの使い方

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

作成日: 更新日:

基本的な使い方

『documentElementプロパティは、DOMDocumentオブジェクトが表すXMLまたはHTMLドキュメントのルート要素を保持するプロパティです。ルート要素とは、ドキュメント全体の階層構造における最上位の要素を指し、例えばHTMLドキュメントでは通常<html>要素がこれに該当します。このプロパティを利用することで、ドキュメントの構造を解析したり操作したりする際の起点となる要素へ直接アクセスすることが可能になります。documentElementプロパティが返す値はDOMElementオブジェクトであるため、このオブジェクトのメソッドやプロパティを続けて利用することで、子要素である<head><body>要素をたどったり、属性を読み書きしたりといった、より具体的な操作へ進むことができます。ドキュメントが空である、あるいはルート要素がまだ追加されていない状態の場合、このプロパティはnullを返します。このプロパティは読み取り専用であり、直接値を代入してルート要素を変更することはできません。

構文(syntax)

1<?php
2// DOMDocumentオブジェクトを作成します
3$dom = new DOMDocument();
4
5// XML文字列を読み込みます
6$dom->loadXML('<root><item>Hello, World!</item></root>');
7
8// documentElementプロパティを使ってドキュメントのルート要素(<root>)を取得します
9$rootElement = $dom->documentElement;
10
11// 取得したルート要素のタグ名を出力します
12// 出力: "root"
13echo $rootElement->nodeName;
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMElement|null

DOMDocumentオブジェクトのルート要素であるDOMElement、またはドキュメントが空の場合はnullを返します。

関連コンテンツ

関連プログラミング言語