DOMDocument::createComment()
(PHP 5, PHP 7)
Create new comment node
说明
public DOMDocument::createComment(string $data): DOMComment
This function creates a new instance of class DOMComment.此节点出现在文档中，除非是用诸如DOMNode->appendChild()等函数来将其插入。
参数
- $data
The content of the comment.
返回值
The new DOMComment or FALSE if an error occurred.
参见
- DOMNode::appendChild() Adds new child at the end of the children
- 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
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.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.