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

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

作成日: 2025年09月11日更新日: 2025年11月08日

基本的な使い方

nodeNameプロパティは、Dom\XMLDocumentクラスに属し、XMLドキュメント内のノードの名称を保持するプロパティです。

このプロパティは、PHPのDOM拡張機能において、XMLドキュメントを構成する様々なノード（要素、属性、テキストなど）の名称を文字列として取得するために使用されます。しかし、Dom\XMLDocumentクラスのインスタンス自体は、XMLドキュメント全体を表す特別な「ドキュメントノード」であるため、そのnodeNameプロパティにアクセスした場合、XMLドキュメントのルート要素名ではなく、常に特別な文字列#documentを返します。これは、XMLドキュメントそのものが特定のタグ名を持たない文書構造の最上位を表すためです。

例えば、XMLドキュメント内の特定の子要素のnodeNameは、その要素のタグ名を返しますが、ドキュメント全体を扱うDom\XMLDocumentオブジェクトのnodeNameは#documentとなります。このプロパティは読み取り専用であり、ノードの名称をプログラムから変更することはできません。

XMLドキュメントの構造を解析したり、プログラムで特定のノードを識別したりする際に、ノードがどのような名前を持っているかを判断するための基本的な情報源となります。特に、XMLデータの処理や操作を行うシステムにおいて、ノードの種類や役割を理解するための重要な手がかりとなるでしょう。XMLを扱う上での基本を学ぶ上で、このプロパティの挙動を理解することは非常に役立ちます。

構文(syntax)


1<?php
2
3$document = new DOMDocument();
4$name = $document->nodeName;
5echo $name;
6
7?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

Dom\XMLDocument クラスの nodeName プロパティは、ノードの名前を表す文字列を返します。

サンプルコード

PHP DomDocument nodeName を取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\XMLDocumentのnodeNameプロパティの使用例を示します。
7 */
8function demonstrateXmlDocumentNodeName(): void
9{
10    // 1. Dom\XMLDocumentクラスのインスタンスを生成します。
11    // PHP 8以降で推奨される名前空間付きのクラス名です。
12    $document = new Dom\XMLDocument();
13
14    // 2. 簡単なXML文字列をドキュメントに読み込みます。
15    // loadXML()メソッドは、文字列が整形式XMLでない場合にfalseを返します。
16    $xmlString = '<?xml version="1.0" encoding="UTF-8"?><root><child>content</child></root>';
17    $document->loadXML($xmlString);
18
19    // 3. XMLDocumentオブジェクト自身の`nodeName`プロパティにアクセスします。
20    // ドキュメントノードのノード名は、常に特殊な文字列 "#document" になります。
21    // これは、ドキュメント全体を表すルートノードであることを示します。
22    $documentNodeName = $document->nodeName;
23
24    // 4. 取得したノード名を出力します。
25    echo 'The nodeName of the XMLDocument object is: ' . $documentNodeName . PHP_EOL;
26
27    // 参考: ルート要素（この例では<root>）のノード名を取得する場合
28    if ($document->documentElement) {
29        $rootElementNodeName = $document->documentElement->nodeName;
30        echo 'The nodeName of the root element (<root>) is: ' . $rootElementNodeName . PHP_EOL;
31    }
32}
33
34// 関数を実行してサンプルコードの動作を確認します。
35demonstrateXmlDocumentNodeName();

このサンプルコードは、PHP 8で導入されたDom\XMLDocumentクラスのnodeNameプロパティがどのように機能するかを示しています。nodeNameプロパティは、XMLドキュメント内のノード（要素、属性、テキストなど）の名前を取得するために使用されます。戻り値は常にstring型で、ノードの名前を表す文字列を返します。

コードではまず、Dom\XMLDocumentのインスタンスを生成し、簡単なXML文字列をloadXML()メソッドで読み込みます。次に、$document->nodeNameにアクセスしています。Dom\XMLDocumentオブジェクト自体（XMLドキュメント全体を表すノード）のnodeNameは、常に特殊な文字列"#document"となります。これは、そのノードがドキュメントルートであることを示します。

さらに、参考として、XMLドキュメント内の具体的な要素（この例では<root>要素）のノード名を取得する方法も示されています。$document->documentElementを通じてルート要素にアクセスし、そのnodeNameプロパティを参照すると、要素のタグ名である"root"が取得できます。このように、nodeNameはXML構造をプログラムで操作する際に、各ノードの識別や処理の分岐に役立つ重要なプロパティです。

Dom\XMLDocumentオブジェクトのnodeNameプロパティは、XMLドキュメント自体（ルートノード）の名前を表し、常に#documentを返します。XMLドキュメント全体の名前を知りたい場合に利用します。特定の要素（例: <root>要素）のノード名を取得したい場合は、documentElementプロパティを経由して要素オブジェクトを取得し、そのnodeNameプロパティにアクセスする必要があります。loadXML()メソッドは、XML文字列が不正な場合にfalseを返すため、エラーハンドリングを検討してください。XML処理では文字エンコーディングも重要です。サンプルコードではUTF-8を指定していますが、実際のXMLファイルのエンコーディングと一致するように注意してください。