【PHP8.x】createCommentメソッドの使い方

createCommentメソッドは、Dom\Documentクラスに属し、XML/HTMLドキュメント内に新しいコメントノードを作成するメソッドです。

このメソッドは、引数として渡された文字列データをもとに、<!-- コメント -->のような形式のコメントを表すDOMCommentオブジェクトを生成します。これは、ドキュメント構造に影響を与えず、情報追加や要素の一時的な無効化に活用できます。

メソッドを呼び出す際には、コメントとして挿入したい内容の文字列を渡します。そして、このメソッドは、文字列データを持つDOMCommentオブジェクトを戻り値として返します。

ただし、このメソッドでコメントを作成しただけでは、ドキュメントのどこにも追加されません。生成されたコメントノードをドキュメントツリーに追加するには、appendChildやinsertBeforeメソッドを使って既存ノードの子として追加する必要があります。

これにより、プログラムからドキュメント内にコメントを動的に挿入・管理することが可能になります。

Copy
1<?php
2
3$document = new Dom\Document();
4$commentNode = $document->createComment('コメント内容');
5
6?>

string $data

• string $data: 生成するコメントのコンテンツを指定する文字列

Dom\Comment

指定された文字列を引数として、新しい Dom\Comment オブジェクトを生成して返します。