DOMDocument::createComment

(PHP 5, PHP 7, PHP 8)

DOMDocument::createCommentCrea un nuevo nodo de comentario

Descripción

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

Esta función crea una nueva instancia de la clase DOMComment. Este nodo no se mostrará en el documento a no ser que sea insertado con (p.e.j.) DOMNode::appendChild().

Parámetros

data

El contenido del comentario.

Valores devueltos

El nuevo DOMComment o false si ha ocurrido un error.

Ver también

add a note add a note

User Contributed Notes 2 notes

up
-1
php dot sirlancelot at spamgourmet dot com
15 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
17 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