parent root
PHP: DOMDocument::createComment - Manual

DOMDocument::createComment

(PHP 5, PHP 7)

DOMDocument::createCommentCreate new comment node

Description

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

This function creates a new instance of class DOMComment. This node will not show up in the document unless it is inserted with (e.g.) DOMNode::appendChild().

Parameters

data

The content of the comment.

Return Values

The new DOMComment or FALSE if an error occurred.

See Also

add a noteadd a note

User Contributed Notes 2 notes

up
0
php dot sirlancelot at spamgourmet dot com
9 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
-6
capps at solareclipse dot net
12 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
parent root