DOMDocument::createComment

(PHP 5, PHP 7, PHP 8)

DOMDocument::createCommentCreate new comment node

Beschreibung

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

This function creates a new instance of class DOMComment. Dieser Knoten wird in Ihrem Dokument nicht sichtbar sein, bis dieser zum Beispiel mit der Funktion DOMNode::appendChild() eingefügt wird.

Parameter-Liste

data

The content of the comment.

Rückgabewerte

The new DOMComment.

Changelog

Version Beschreibung
8.1.0 In case of an error, a DomException is thrown now. Previously, false was returned.

Siehe auch

add a note

User Contributed Notes 2 notes

up
-1
php dot sirlancelot at spamgourmet dot com
12 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
-7
capps at solareclipse dot net
15 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