【PHP8.x】Dom\Comment::nodeNameプロパティの使い方

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

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

基本的な使い方

nodeNameプロパティは、PHPのDOM拡張機能におけるDom\Commentクラスのインスタンスが表すノードの名前を保持するプロパティです。

Dom\Commentクラスは、HTMLやXMLといったマークアップ言語のドキュメント内に記述されたコメント（例えば  のような形式）をプログラムで扱うためのものです。これらのドキュメントは、要素、テキスト、コメントといった様々な部品（これらを「ノード」と呼びます）で構成されており、それぞれに固有のタイプと名前が割り当てられています。

このnodeNameプロパティは、ドキュメント内の特定のノードがどのような種類であるかを識別するために利用されます。Dom\Commentクラスのインスタンスに対してこのプロパティにアクセスすると、常に固定の文字列である #comment が返されます。これは、W3C（World Wide Web Consortium）によって定められたDOM（Document Object Model）の仕様に基づき、コメントノードであることを示す標準的な識別子です。

したがって、ドキュメントツリーを走査する際に、あるノードがコメントノードであるかどうかをプログラムで判別したい場合に、$node->nodeName === '#comment' のようにこのプロパティの値を比較して利用することができます。このプロパティはコメントの内容そのものを返すものではなく、あくまでノードの種類を示す識別子として機能します。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$commentNode = $dom->createComment('これはテストコメントです');
4
5// Dom\Comment オブジェクトの nodeName プロパティにアクセス
6echo $commentNode->nodeName;
7?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

Dom\Comment::nodeName プロパティは、このノードの名称を表す文字列を返します。コメントノードの場合、この値は常に #comment となります。

サンプルコード

PHP DOMComment nodeName を取得する


1<?php
2
3// DomComment の nodeName プロパティのサンプルコード
4
5// 新しい DOMDocument を作成します。
6$dom = new DOMDocument();
7
8// コメントノードを作成します。
9$comment = $dom->createComment("これはコメントです");
10
11// コメントノードをドキュメントに追加します (ルート要素がないため、追加先はどこでも可)。
12$dom->appendChild($comment);
13
14// nodeName プロパティを取得して表示します。
15$nodeName = $comment->nodeName;
16
17echo "ノード名: " . $nodeName . PHP_EOL;
18
19?>

PHPのDOMCommentクラスにおけるnodeNameプロパティについて解説します。このプロパティは、コメントノードの名前（ノードタイプ）を表す文字列を取得するために使用します。

上記のサンプルコードでは、まずDOMDocumentクラスのインスタンスを作成し、createComment()メソッドを用いてコメントノードを生成しています。生成されたコメントノードは、appendChild()メソッドを使ってDOMドキュメントに追加されます。

nodeNameプロパティは引数を必要としません。コメントノードのnodeNameプロパティにアクセスすると、常に文字列 #comment が返されます。これは、コメントノードのノードタイプを表す固定値です。サンプルコードでは、$comment->nodeNameによってノード名を取得し、echo文でその値を表示しています。

nodeNameプロパティは読み取り専用であり、値を変更することはできません。このプロパティは、ノードの種類を識別するために利用されます。DOMツリーを操作する際に、ノードの種類を判別し、適切な処理を行うために役立ちます。例えば、特定のノードタイプのみを処理するような場合に、nodeNameプロパティを使ってノードの種類を確認できます。

DomCommentクラスのnodeNameプロパティは、常に#commentという文字列を返します。これはコメントノードの型を表す固定値であり、コメントの内容そのものを取得するものではない点に注意が必要です。コメントの内容を取得するには、nodeValueプロパティを使用します。nodeNameは読み取り専用のプロパティなので、値を変更しようとしても効果はありません。DOMDocumentにコメントを追加する際は、適切なノードに追加しないと、意図した場所にコメントが表示されないことがあります。