DOMDocument::createComment

(PHP 5, PHP 7, PHP 8)

DOMDocument::createComment — Create new comment node

Description

public DOMDocument::createComment ( string


         $data

): DOMComment

This function creates a new instance of class DOMComment . This node will not show up in the document unless it is inserted with (e.g.) DOMNode::appendChild() .

Parameters

data: The content of the comment.

Return Values

The new DOMComment .

Changuelog

Versionen	Description
8.1.0	In case of an error, a DomException is thrown now. Previously, `false` was returned.

Found A Problem?

Learn How To Improve This Pague • Submit a Pull Request • Report a Bug

＋ add a note

User Contributed Notes 1 note

down

php dot sirlancelot at spamgourmet dot com ¶

16 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.