The DOMComment class

(PHP 5, PHP 7, PHP 8)

Introduction

Represents comment nodes, characters delimited by .

Class synopsis

class DOMComment extends DOMCharacterData {

/* Inherited properties */

public string $data;

public readonly int $length;

public readonly ?DOMElement $previousElementSibling;

public readonly ?DOMElement $nextElementSibling;

public readonly string $nodeName;

public ?string $nodeValue;

public readonly int $nodeType;

public readonly ?DOMNode $parentNode;

public readonly ?DOMElement $parentElement;

public readonly DOMNodeList $childNodes;

public readonly ?DOMNode $firstChild;

public readonly ?DOMNode $lastChild;

public readonly ?DOMNode $previousSibling;

public readonly ?DOMNode $nextSibling;

public readonly ?DOMNamedNodeMap $attributes;

public readonly bool $isConnected;

public readonly ?DOMDocument $ownerDocument;

public readonly ?string $namespaceURI;

public string $prefix;

public readonly ?string $localName;

public readonly ?string $baseURI;

public string $textContent;

/* Methods */

public __construct(string $data = "")

/* Inherited methods */

public DOMCharacterData::after(DOMNode|string ...$nodes): void

public DOMCharacterData::appendData(string $data): true

public DOMCharacterData::before(DOMNode|string ...$nodes): void

public DOMCharacterData::deleteData(int $offset, int $count): bool

public DOMCharacterData::insertData(int $offset, string $data): bool

public DOMCharacterData::remove(): void

public DOMCharacterData::replaceData(int $offset, int $count, string $data): bool

public DOMCharacterData::replaceWith(DOMNode|string ...$nodes): void

public DOMCharacterData::substringData(int $offset, int $count): string|false

public DOMNode::appendChild(DOMNode $node): DOMNode|false

public DOMNode::C14N(
    bool $exclusive = false,
    bool $withComments = false,
    ?array $xpath = null,
    ?array $nsPrefixes = null
): string|false

public DOMNode::C14NFile(
    string $uri,
    bool $exclusive = false,
    bool $withComments = false,
    ?array $xpath = null,
    ?array $nsPrefixes = null
): int|false

public DOMNode::cloneNode(bool $deep = false): DOMNode|false

public DOMNode::compareDocumentPosition(DOMNode $other): int

public DOMNode::contains(DOMNode|DOMNameSpaceNode|null $other): bool

public DOMNode::getLineNo(): int

public DOMNode::getNodePath(): ?string

public DOMNode::getRootNode(?array $options = null): DOMNode

public DOMNode::hasAttributes(): bool

public DOMNode::hasChildNodes(): bool

public DOMNode::insertBefore(DOMNode $node, ?DOMNode $child = null): DOMNode|false

public DOMNode::isDefaultNamespace(string $namespace): bool

public DOMNode::isEqualNode(?DOMNode $otherNode): bool

public DOMNode::isSameNode(DOMNode $otherNode): bool

public DOMNode::isSupported(string $feature, string $version): bool

public DOMNode::lookupNamespaceURI(?string $prefix): ?string

public DOMNode::lookupPrefix(string $namespace): ?string

public DOMNode::normalize(): void

public DOMNode::removeChild(DOMNode $child): DOMNode|false

public DOMNode::replaceChild(DOMNode $node, DOMNode $child): DOMNode|false

}

Note that textContent property of a comment is not entity decoded, it is decoded in DOMElement::textContent :

<?php 

   $xml = new DOMDocument();
    $xml->loadXML('<?xml version="1.0" encoding="utf-8"?>
      <configuration version="2">
      <!-- test &#45;&#45;&gt; -->
      test &#45;&#45;&gt;
      </configuration>'
    );
$xpath = new DOMXPath($xml);
$comments = $xpath->query('//comment()');
$elements = $xpath->query('//configuration');

echo $comments[0]->textContent;
// result: test &#45;&#45;&gt;

echo $elements[0]->textContent;
// result: test -->

?>

＋add a note

The DOMComment class

Introduction

Class synopsis

See Also

Table of Contents

Improve This Page

User Contributed Notes 1 note