DOMDocument::createComment

(PHP 5, PHP 7, PHP 8)

DOMDocument::createComment — Create new comment node

Descrição

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

This function creates a new instance of class DOMComment. Este nó não aparecerá no documento a menos que seja inserido, por exemplo, com DOMNode::appendChild().

Parâmetros

data: The content of the comment.

Valor Retornado

The new DOMComment.

Changelog

Versão	Descrição
8.1.0	In case of an error, a DomException is thrown now. Previously, `false` was returned.

Veja Também

DOMNode::appendChild() - Adiciona um novo filho ao final dos filhos
DOMDocument::createAttribute() - Create new attribute
DOMDocument::createAttributeNS() - Create new attribute node with an associated namespace
DOMDocument::createCDATASection() - Create new cdata node
DOMDocument::createDocumentFragment() - Create new document fragment
DOMDocument::createElement() - Create new element node
DOMDocument::createElementNS() - Create new element node with an associated namespace
DOMDocument::createEntityReference() - Create new entity reference node
DOMDocument::createProcessingInstruction() - Creates new PI node
DOMDocument::createTextNode() - Create new text node

＋add a note

User Contributed Notes 2 notes

down

-1

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.

down

-8

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.

＋add a note