DOMDocument::createComment

(PHP 5, PHP 7, PHP 8)

DOMDocument::createComment Создать новый узел комментария

Описание

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

Эта функция создаёт новый экземпляр класса DOMComment. Этот узел не будет отображаться в документе до тех пор, пока он не будет вставлен, например, функцией DOMNode::appendChild().

Список параметров

data

Содержимое комментария.

Возвращаемые значения

Новый объект класса DOMComment.

Список изменений

Версия Описание
8.1.0 В случае возникновения ошибки теперь выбрасывает исключение DomException. Ранее вместо этого возвращалось значение false.

Смотрите также

add a note add a note

User Contributed Notes 2 notes

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