DOMDocument::createComment

(PHP 5, PHP 7, PHP 8)

DOMDocument::createCommentCrée un nouveau nœud de commentaire

Description

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

Cette fonction crée une nouvelle instance de la classe DOMComment. Ce nœud ne sera pas affiché dans le document, à moins qu'il ne soit inséré avec DOMNode::appendChild().

Liste de paramètres

data

Le contenu du commentaire.

Valeurs de retour

Le nouveau DOMComment.

Historique

Version Description
8.1.0 En cas d'erreur, une DomException est désormais lancée. Auparavant, false était retourné.

Voir aussi

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