【PHP8.x】DOMDocument::createComment()メソッドの使い方

createCommentメソッドの使い方について、初心者にもわかりやすく解説します。

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

基本的な使い方

createCommentメソッドは、XMLやHTMLなどのDOM（Document Object Model）ドキュメント内に、新しいコメントノードを作成するメソッドです。このメソッドは、DOMDocumentクラスに属しており、ドキュメントの構造を操作する際に利用されます。

具体的には、引数としてコメントの内容となる文字列を受け取ります。例えば、$document->createComment('これはテストコメントです'); のように使用することで、「」という形式のコメントノードが生成されます。このメソッドによって作成されたコメントノードは、まだドキュメントツリーには追加されていません。実際にドキュメント内に表示したり、保存したりするためには、appendChildやinsertBeforeなどのDOM操作メソッドを使って、ドキュメントツリーの適切な位置に手動で追加する必要があります。

コメントノードは、ブラウザでの表示やXMLパーサによる構造解析には影響を与えず、人間がドキュメントの内容を理解しやすくするためのメモや一時的な情報として利用されます。システムエンジニアを目指す方にとって、ドキュメントの内部構造を理解し、意味のある情報を埋め込むために、このcreateCommentメソッドの利用は非常に重要です。正しくコメントを管理することで、コードの可読性やメンテナンス性が向上します。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$commentNode = $dom->createComment('これはXMLコメントとして扱われるテキストです');
4?>

引数(parameters)

string $data

string $data: 作成するコメントの内容を指定する文字列

戻り値(return)

DOMComment

DOMDocumentオブジェクトに新しいコメントノードを作成し、それを返します。

サンプルコード

PHP DOMDocument::createComment で動的コメントを生成する


1<?php
2
3/**
4 * DOMDocument::createComment() を使用して、動的な情報を埋め込んだHTMLページを生成します。
5 *
6 * この関数は、システムの生成時刻などのメタデータをHTMLコメントとしてページに含めます。
7 * これは、ウェブページのソースコードに、ブラウザからは見えない追加情報（例: デバッグ情報、
8 * 生成スクリプトのバージョン、最終更新日時など）を含める一般的な手法です。
9 * WordPressの comments_template() が動的なコメントリストを表示するように、
10 * こちらもDOM操作によって動的なコメントを生成する例としています。
11 */
12function generatePageWithDynamicComment(): void
13{
14    // 新しいDOMDocumentインスタンスを作成します。
15    // バージョン1.0、UTF-8エンコーディングを指定します。
16    $dom = new DOMDocument('1.0', 'UTF-8');
17
18    // 生成されるHTMLコードを整形するために、formatOutputをtrueに設定します。
19    $dom->formatOutput = true;
20
21    // HTMLのルート要素 <html> を作成し、ドキュメントに追加します。
22    $htmlElement = $dom->createElement('html');
23    $dom->appendChild($htmlElement);
24
25    // <body> 要素を作成し、<html> 要素の子として追加します。
26    $bodyElement = $dom->createElement('body');
27    $htmlElement->appendChild($bodyElement);
28
29    // ページタイトルとして <h1> 要素を作成し、<body> に追加します。
30    $titleElement = $dom->createElement('h1', 'DOMDocument::createComment のサンプルページ');
31    $bodyElement->appendChild($titleElement);
32
33    // 説明文として <p> 要素を作成し、<body> に追加します。
34    $paragraphElement = $dom->createElement('p', 'このページはPHPスクリプトによって動的に生成されました。');
35    $bodyElement->appendChild($paragraphElement);
36
37    // DOMDocument::createComment() メソッドを使用して、新しいHTMLコメントノードを作成します。
38    // コメントの内容には、スクリプトが実行された現在の日時を動的に含めます。
39    $commentData = sprintf(
40        '<!-- このページは %s に生成されました。スクリプトバージョン: 1.0.0 -->',
41        date('Y-m-d H:i:s')
42    );
43    $commentNode = $dom->createComment($commentData);
44
45    // 作成したコメントノードを <body> 要素の最後の子として追加します。
46    // このコメントはブラウザ上には表示されませんが、ページのソースコードを確認すると見ることができます。
47    $bodyElement->appendChild($commentNode);
48
49    // 生成されたHTMLドキュメントを文字列として出力します。
50    // ブラウザがHTMLとして正しく解釈できるようにContent-Typeヘッダーを設定します。
51    header('Content-Type: text/html; charset=UTF-8');
52    echo $dom->saveHTML();
53}
54
55// 上記の関数を実行し、HTMLページを生成して出力します。
56generatePageWithDynamicComment();

DOMDocument::createCommentは、PHPのDOMDocumentクラスが提供するメソッドで、HTMLやXMLドキュメント内にコメントノードを新規に作成するために使用されます。

このメソッドは、引数としてstring $dataを受け取ります。この$dataには、作成したいコメントの内容を文字列として指定します。例えば、createComment('このコメントは動的に生成されました')とすることで、「」という形式のコメントのコンテンツ部分を指定できます。

メソッドの戻り値は、作成された新しいコメントノードを表すDOMCommentオブジェクトです。このDOMCommentオブジェクトは、その後DOMDocument内の他の要素（例えば、<body>タグなど）の子として追加することで、ドキュメントに組み込むことができます。

サンプルコードでは、DOMDocument::createCommentを利用して、ウェブページの生成時刻などの動的な情報を含むHTMLコメントを作成しています。まず、new DOMDocument()で新しいHTMLドキュメントを初期化し、htmlやbodyといった基本的な要素を生成します。次に、date('Y-m-d H:i:s')関数で取得した現在の時刻を文字列に埋め込み、それをcreateComment()の引数として渡すことで、動的なコメントノードを生成しています。このコメントノードは$bodyElement->appendChild($commentNode)によってHTMLの<body>要素の最後に追加されます。

このようにして動的に生成されたコメントは、ブラウザ上では表示されませんが、ページのソースコードを確認することで見ることができます。これは、WordPressのcomments_template()が動的なコメントリストを表示するように、ページのソースにシステム情報やデバッグ情報といった目に見えない追加情報を埋め込む一般的な手法として活用されます。最終的に、$dom->saveHTML()によって生成されたHTMLドキュメントが文字列として出力されます。

DOMDocument::createComment()の引数には、コメントのテキスト部分のみを指定します。サンプルコードのようにを含めると、コメント記号が二重になってしまうため注意が必要です。生成されたコメントはブラウザ上には表示されませんが、ページのソースコードには残り、誰でも閲覧可能です。そのため、個人情報や機密性の高い情報をコメントに含めないよう十分に気を付けてください。また、DOM操作では、作成した要素は必ずappendChild()などでドキュメントツリーに追加しないと、HTMLに反映されません。HTMLを出力する際には、header('Content-Type: text/html; charset=UTF-8');を設定することで、ブラウザが正しくコンテンツを解釈できるようになります。WordPressのcomments_template()は動的なコメントリストを表示する関数であり、createComment()でHTMLコメントを直接生成する用途とは異なりますので、混同しないようにしてください。

PHP DOMDocumentでXMLコメントを作成する


1<?php
2
3/**
4 * DOMDocument::createComment メソッドの使用例。
5 * HTML/XML ドキュメント内にコメントノードを作成し、ドキュメントに追加する方法を示します。
6 *
7 * このメソッドで生成されるのは、PHP コードのコメント (例: // や /* *) ではなく、
8 * HTML/XML ドキュメントの構造の一部となる <!-- ... --> 形式のコメントです。
9 * システムエンジニアにとって、XML/HTML ドキュメントをプログラムで操作する際に重要となります。
10 */
11function createDomCommentExample(): void
12{
13    // 新しい DOMDocument オブジェクトを作成します。
14    // '1.0' は XML のバージョン、'UTF-8' はエンコーディングを指定します。
15    $dom = new DOMDocument('1.0', 'UTF-8');
16
17    // 出力時に XML を整形するために true に設定します。
18    $dom->formatOutput = true;
19
20    // ドキュメントのルート要素として 'document' という要素を作成し、追加します。
21    $rootElement = $dom->createElement('document');
22    $dom->appendChild($rootElement);
23
24    // DOMDocument::createComment メソッドを使用してコメントノードを作成します。
25    // 引数にはコメントの内容を示す文字列を渡します。
26    $commentNode = $dom->createComment('これは XML ドキュメントに追加されるコメントです。');
27
28    // 作成したコメントノードをルート要素の子として追加します。
29    // これにより、XML/HTML の出力にコメントが含められます。
30    $rootElement->appendChild($commentNode);
31
32    // 別の子要素を作成し、その中にもコメントを追加する例。
33    $dataElement = $dom->createElement('data');
34    $rootElement->appendChild($dataElement);
35
36    $innerCommentNode = $dom->createComment('データ要素に関するメモ');
37    $dataElement->appendChild($innerCommentNode);
38
39    $textNode = $dom->createTextNode('サンプルデータ');
40    $dataElement->appendChild($textNode);
41
42    // 構築した DOMDocument オブジェクトの内容を XML 文字列として出力します。
43    echo $dom->saveXML();
44}
45
46// 関数を実行して、生成された XML を表示します。
47createDomCommentExample();
48
49?>

DOMDocument::createCommentメソッドは、PHPでHTMLやXMLドキュメントをプログラム的に構築する際に、ドキュメント内にコメントノードを作成するために使用されます。これは、PHPコード自体をコメントアウトする//や/* */とは異なり、生成されるHTML/XMLドキュメントの構造の一部として形式のコメントを埋め込むためのものです。

このメソッドは引数としてstring $dataを受け取ります。この$dataには、ドキュメントに含めたいコメントの内容を文字列で指定します。例えば「これは重要な情報です」と指定すれば、ドキュメントにはと出力されます。メソッドの戻り値はDOMCommentオブジェクトで、これは作成されたコメントノード自体を表します。この戻り値のオブジェクトをDOMDocumentや既存の要素にappendChildメソッドを使って追加することで、コメントをドキュメント内の指定された位置に挿入できます。

サンプルコードでは、新しいDOMDocumentを作成し、その中にルート要素を追加した後、createCommentメソッドでコメントノードを生成しています。そして、生成したコメントノードをルート要素の子として追加することで、最終的にsaveXML()で出力されるXML文字列にコメントが実際に含まれることを示しています。システムエンジニアがXML/HTMLドキュメントを動的に生成・編集する際に、ドキュメントの構造や内容に関する注釈をプログラム的に挿入する際に役立ちます。

DOMDocument::createCommentメソッドは、PHPコードのコメント（//や/* */）とは異なり、HTMLやXMLドキュメント内に表示される形式のコメントノードを作成します。この点を混同しないようご注意ください。

生成されたコメントノードは、必ずappendChildメソッドを使ってドキュメントツリー内の適切な要素に追加しなければ、出力には現れません。

コメントの内容には、--（ハイフン2つ）という文字列を含めないように特に注意が必要です。これはXMLのコメント終了区切りと誤解され、パースエラーや予期せぬ動作を引き起こす可能性があります。

また、HTML/XMLコメントはクライアント側から容易に閲覧できるため、パスワードなどの機密情報は絶対に記述しないでください。デバッグ情報や構造の説明など、公開されても問題ない情報に限定して活用することをお勧めします。