Dom\HTMLDocument::saveXmlFile

(PHP 8 >= 8.4.0)

Dom\HTMLDocument::saveXmlFile — Serializes the document as an XML file

Description

public function Dom\HTMLDocument::saveXmlFile(string $filename, int $options = 0): int|false

Serializes the document as an XML file.

Parameters

filename

The path to the file to save to.

options

Additional Options. The LIBXML_NOEMPTYTAG and LIBXML_NOXMLDECL options are supported. Prior to PHP 8.3.0, only the LIBXML_NOEMPTYTAG option is supported.

Return Values

The number of bytes written on success, or false on failure.

Errors/Exceptions

  • Throws a ValueError if filename is an empty string or contains any null bytes.

Examples

Example #1 Dom\HTMLDocument::saveXmlFile() example

Serializes a document to an XML file.

<?php
$dom = Dom\HTMLDocument::createFromString('<!DOCTYPE html><p>Hello, world!</p>');
$bytes = $dom->saveXmlFile('/path/to/output.xml');
echo "Saved $bytes bytes\n";
var_dump($bytes);
?>

The above example will output:

Saved 168 bytes
int(168)

See Also