CakeFest 2024: The Official CakePHP Conference

DOMDocument::createComment

(PHP 5, PHP 7, PHP 8)

DOMDocument::createComment新しい comment ノードを作成する

説明

public DOMDocument::createComment(string $data): DOMComment

この関数は、DOMComment クラスの新しいインスタンスを作成します。このノードは、( DOMNode::appendChild() などで) 挿入されない限り、ドキュメント内にあらわれません。

パラメータ

data

コメントの内容。

戻り値

新しい DOMComment を返します。

変更履歴

バージョン 説明
8.1.0 エラーが発生した場合に、 DomException をスローするようになりました。 これより前のバージョンでは、false を返していました。

参考

add a note

User Contributed Notes 2 notes

up
0
php dot sirlancelot at spamgourmet dot com
14 years ago
To prevent a parser error when the comment string would contain the character sequence "--", do this:

<?php

$CommentString
= 'This contains -- some weird -- characters.';

$CommentNode = $DomDocument->createComment(
str_replace('--', '-'.chr(194).chr(173).'-', $CommentString)
);
?>

This will insert a Soft Hyphen in between the two hyphens which will not cause the parser to error out.
up
-9
capps at solareclipse dot net
16 years ago
Use caution: this function does NOT escape, encode, or otherwise change the contents of the string.

This means that if your string contains two hyphens in a row (--), that will *end* the comment, which can easily create invalid XML when the document is serialized.
To Top