【PHP8.x】nodeNameプロパティの使い方
nodeNameプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
nodeNameプロパティは、DOMNodeオブジェクトが表すノードの名前を保持するプロパティです。PHPのDOM拡張機能において、HTMLやXML文書の構造をプログラムで扱う際、文書内の各構成要素（要素、属性、テキストなど）はDOMNodeという基底クラスを継承したオブジェクトとして表現されます。このプロパティは、そうした各ノードがどのような名前を持っているかを文字列として取得するために利用されます。
ノードの種類によってnodeNameが返す値は異なります。例えば、<div>や<p>といった要素ノードの場合、nodeNameはそのタグ名（divやp）を返します。id="example"のような属性ノードであれば、属性名であるidが返されます。また、テキストコンテンツを表すテキストノードでは#text、コメントを表すコメントノードでは#comment、文書全体を表すドキュメントノードでは#documentといった固定の文字列が返されます。
このプロパティは読み取り専用であり、ノードの名前を直接変更することはできません。主に、現在処理しているノードが特定の要素や属性であるかを確認したり、デバッグ時にノードの種類を素早く判別したりする用途で活用されます。より詳細なノードの種類を厳密に判別したい場合は、nodeTypeプロパティを併用することで、より厳密な制御が可能になります。
構文(syntax)
1<?php 2$dom = new DOMDocument(); 3$dom->loadHTML('<html><body><p>Hello PHP</p></body></html>'); 4 5// <body> タグの DOMNode オブジェクトを取得します。 6$bodyNode = $dom->getElementsByTagName('body')->item(0); 7 8// 取得したノードの nodeName プロパティにアクセスします。 9echo $bodyNode->nodeName; // 出力: body 10?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
string
DOMNode オブジェクトのノード名を表す文字列を返します。
サンプルコード
PHP DOMNode::nodeName でノード名を取得する
1<?php 2 3/** 4 * DOMNodeのnodeNameプロパティが、ノードの種類によって 5 * どのように異なる値を示すかを確認するサンプルコード。 6 */ 7function showNodeNameExamples(): void 8{ 9 // DOMDocumentのインスタンスを作成 10 $dom = new DOMDocument(); 11 12 // 操作対象のシンプルなHTML文字列 13 $htmlString = <<<HTML 14<!DOCTYPE html> 15<html> 16<body> 17 <!-- これはコメントです --> 18 <h1 id="main-title">DOMNode::nodeName サンプル</h1> 19</body> 20</html> 21HTML; 22 23 // HTMLを読み込む (HTML5の警告などを抑制) 24 @$dom->loadHTML($htmlString); 25 26 // DOMXPathは、DOMツリーから特定のノードを効率的に検索するためのクラス 27 $xpath = new DOMXPath($dom); 28 29 // 1. 要素ノード (Element Node) 30 // '//h1' というクエリで、ドキュメント内の最初の<h1>要素ノードを取得 31 $elementNode = $xpath->query('//h1')->item(0); 32 // 要素ノードのnodeNameは、タグ名を小文字で返します (例: "h1") 33 echo '1. 要素ノード: ' . $elementNode->nodeName . PHP_EOL; 34 35 // 2. 属性ノード (Attribute Node) 36 // '//h1/@id' というクエリで、<h1>要素のid属性ノードを取得 37 $attributeNode = $xpath->query('//h1/@id')->item(0); 38 // 属性ノードのnodeNameは、属性名を返します (例: "id") 39 echo '2. 属性ノード: ' . $attributeNode->nodeName . PHP_EOL; 40 41 // 3. テキストノード (Text Node) 42 // '//h1/text()' というクエリで、<h1>要素内のテキストノードを取得 43 $textNode = $xpath->query('//h1/text()')->item(0); 44 // テキストノードのnodeNameは、固定文字列 "#text" を返します 45 echo '3. テキストノード: ' . $textNode->nodeName . PHP_EOL; 46 47 // 4. コメントノード (Comment Node) 48 // '//comment()' というクエリで、ドキュメント内の最初のコメントノードを取得 49 $commentNode = $xpath->query('//comment()')->item(0); 50 // コメントノードのnodeNameは、固定文字列 "#comment" を返します 51 echo '4. コメントノード: ' . $commentNode->nodeName . PHP_EOL; 52 53 // 5. ドキュメントノード (Document Node) 54 // DOMDocumentオブジェクト自体がドキュメントノードです 55 // ドキュメントノードのnodeNameは、固定文字列 "#document" を返します 56 echo '5. ドキュメントノード: ' . $dom->nodeName . PHP_EOL; 57} 58 59// 関数を実行して結果を表示 60showNodeNameExamples(); 61
このPHPのサンプルコードは、HTMLやXML文書の構造を扱うDOMNodeクラスのnodeNameプロパティの挙動を、システムエンジニアを目指す初心者の方にも分かりやすく説明しています。nodeNameプロパティは、各ノードの名前を文字列として返します。このプロパティに引数はなく、常に文字列型の戻り値を返します。
サンプルコードでは、まずHTML文字列をDOMDocumentで読み込み、さまざまな種類のノードを取得しています。例えば、<h1>タグのような「要素ノード」の場合、nodeNameプロパティは小文字のタグ名「h1」を返します。id属性のような「属性ノード」では、属性名そのものである「id」を返します。「DOMNode::nodeName サンプル」のような「テキストノード」では「#text」という固定値を、<!-- これはコメントです -->のような「コメントノード」では「#comment」という固定値を返します。また、HTML文書全体を指す「ドキュメントノード」（DOMDocumentオブジェクト自身）は、「#document」という固定値を返します。
このように、nodeNameプロパティはノードの種類に応じて異なる名前を返すため、プログラムで文書ツリーを走査し、特定のノードの種類を識別する際に非常に有用です。
nodeNameプロパティは、ノードの種類によって異なる値を返します。特に、要素ノード以外のテキストノードやコメントノード、ドキュメントノードでは、タグ名ではなく #text や #comment、#documentといった固定文字列を返すため、常にタグ名を期待しないよう注意が必要です。また、サンプルコードのようにDOMXPath::queryでノードを取得する際、対象のノードが見つからない場合はnullが返されます。その状態でnodeNameプロパティにアクセスすると、エラーが発生しますので、ノードの存在をif ($node !== null)などで必ず確認する習慣をつけましょう。@によるエラー抑制はデバッグを困難にするため、本番環境での利用は推奨されません。エラー発生時には適切にハンドリングすることが重要です。
PHP DOM nodeName でノード名を取得する
1<?php 2 3/** 4 * DOMNode::nodeName プロパティの使用例を示します。 5 * HTML文字列からDOMを作成し、異なる種類のノードのnodeNameプロパティを取得します。 6 * 7 * DOMNode::nodeName は、ノードの名前を文字列として返します。 8 * 例えば、要素ノードではタグ名、テキストノードでは '#text'、コメントノードでは '#comment' を返します。 9 */ 10function demonstrateDomNodeName(): void 11{ 12 // サンプルHTML文字列を定義 13 $html = <<<HTML 14<!DOCTYPE html> 15<html> 16<head> 17 <title>サンプルページ</title> 18</head> 19<body> 20 <!-- これはHTMLコメントです --> 21 <p>これは<b>最初の</b>段落です。</p> 22 <a href="https://example.com">リンク</a> 23</body> 24</html> 25HTML; 26 27 // DOMDocumentオブジェクトを作成 28 $dom = new DOMDocument(); 29 // HTMLを読み込む (エラーは抑制し、サンプルコードを簡潔にします) 30 @$dom->loadHTML($html); 31 32 echo "--- DOMNode::nodeName の使用例 ---\n"; 33 34 // 1. ドキュメントルートノード (<html>) のノード名を取得 35 // DOMDocument::documentElement は、HTMLドキュメントのルート要素 (<html>) を返します。 36 if ($dom->documentElement instanceof DOMElement) { 37 echo "ドキュメントルート要素 (<html>) のノード名: " . $dom->documentElement->nodeName . "\n"; 38 } 39 40 // 2. 特定の要素ノード (<p>) のノード名を取得 41 // getElementsByTagName は、指定されたタグ名を持つすべての要素を DOMNodeList として返します。 42 $paragraphs = $dom->getElementsByTagName('p'); 43 if ($paragraphs->length > 0) { 44 $firstParagraph = $paragraphs->item(0); // 最初の <p> 要素を取得 45 if ($firstParagraph instanceof DOMElement) { 46 echo "最初の<p>要素ノードのノード名: " . $firstParagraph->nodeName . "\n"; 47 48 // 3. テキストノードのノード名を取得 49 // 要素ノードの子ノードを反復処理してテキストノードを探します。 50 foreach ($firstParagraph->childNodes as $childNode) { 51 // nodeType が XML_TEXT_NODE (3) の場合、テキストノードです。 52 if ($childNode->nodeType === XML_TEXT_NODE) { 53 echo "テキストノードのノード名: " . $childNode->nodeName . "\n"; 54 break; // 最初のテキストノードを見つけたらループを終了 55 } 56 } 57 } 58 } 59 60 // 4. コメントノードのノード名を取得 61 // ドキュメントの子ノードを反復処理してコメントノードを探します。 62 foreach ($dom->childNodes as $node) { 63 // nodeType が XML_COMMENT_NODE (8) の場合、コメントノードです。 64 if ($node->nodeType === XML_COMMENT_NODE) { 65 echo "コメントノードのノード名: " . $node->nodeName . "\n"; 66 break; // 最初のコメントノードを見つけたらループを終了 67 } 68 } 69 70 echo "-----------------------------------\n"; 71} 72 73// 関数を実行して、DOMNode::nodeName プロパティの使用例を表示 74demonstrateDomNodeName(); 75 76?>
PHPのDOMNode::nodeNameプロパティは、HTMLやXMLドキュメントの構造を表すDOMツリーにおいて、各ノードの名前を文字列として取得するために使用します。このプロパティは引数を取らず、必ず文字列型の戻り値を返します。
要素ノードの場合、例えば<html>や<p>のようなタグは、そのタグ名（html、p）を返します。しかし、テキストデータを表すテキストノードの場合には#textという固定の文字列が、そしてHTML内のコメント（<!-- ... -->）を表すコメントノードの場合には#commentという文字列が返されるのが特徴です。
提供されたサンプルコードでは、まずHTML文字列を読み込んでDOMツリーを構築し、そこから異なる種類のノードを特定しています。具体的には、ドキュメントのルート要素である<html>、最初の<p>要素、その<p>要素内のテキストノード、そしてHTMLコメントノードについて、それぞれnodeNameプロパティの値を取得し、その違いを明確に示しています。これにより、PHPを使ってHTMLの構造をプログラムで解析する際に、各ノードが何であるかを識別する基本的な方法を学ぶことができます。
DOMNode::nodeNameは、ノードの種類によって異なる名前を返します。要素ノードではタグ名が、テキストノードでは「#text」、コメントノードでは「#comment」が返されるため、戻り値の種類に注意が必要です。サンプルコードの@記号によるエラー抑制は、問題発生時の原因特定を難しくするため、実際の開発ではtry-catchブロックなどを用いて適切なエラーハンドリングを行うようにしましょう。DOM操作では、対象のノードが存在しない場合にエラーとならないよう、必ず事前にノードの有無（例：$elements->length > 0やnullチェック）を確認することが安全なコードにつながります。ノードの種類を厳密に判別したい場合は、nodeNameだけでなくnodeTypeプロパティも活用すると良いでしょう。