A common use for DOMDocument::save is processing data without rebuilding the operation manually. Serializes and saves the XML document to a file.
What Is DOMDocument::save in PHP?
Serializes and saves the XML document to a file.
Syntax:
DOMDocument::save($filename, $options)
Parameters and Return Value
$filename— The source or destination filename.$options— Bitmask or flags that configure the operation.
Check the returned value, including false when applicable, or handle exceptions for invalid input. The required XML/DOM extension must be installed.
Example 1: Basic Usage
This example demonstrates the main operation with a small, controlled input.
<?php
$xmlDocument = new DOMDocument("1.0", "UTF-8");
$xmlDocument->loadXML("<catalog><item id=\"one\">First</item></catalog>");
$bytesWritten = $xmlDocument->save(__DIR__ . "/export.xml");
var_dump($bytesWritten);
The result depends on the supplied data and the documented operation. Output is not shown as a fixed value when files, locales or runtime configuration can change it.
Example 2: Another Input
This example changes the input or surrounding setup to illustrate another behavior.
<?php
$xmlDocument = new DOMDocument("1.0", "UTF-8");
$xmlDocument->loadXML("<catalog><item id=\"one\">Updated item</item></catalog>");
$bytesWritten = $xmlDocument->save(__DIR__ . "/export.xml");
var_dump($bytesWritten);
The result depends on the supplied data and the documented operation. Output is not shown as a fixed value when files, locales or runtime configuration can change it.
Practical Example
This application-style example shows a self-contained usage pattern and checks its result.
<?php
$xmlDocument = new DOMDocument("1.0", "UTF-8");
$xmlDocument->loadXML("<inventory><item id=\"one\">Inventory</item></inventory>");
$bytesWritten = $xmlDocument->save(__DIR__ . "/export.xml");
var_dump($bytesWritten);
The result depends on the supplied data and the documented operation. Output is not shown as a fixed value when files, locales or runtime configuration can change it.
Important Behavior and Edge Cases
- Do not enable external entity loading for untrusted XML. The legacy DOMDocument HTML parser and the modern PHP 8.4 HTML parser follow different HTML parsing rules.
- Use the intended input type and handle empty or malformed values explicitly.
- Where this API requires an extension, version, or file, document that dependency before using it in a real application.
Comparison With Related Functions
| Function or Method | When to Use It |
|---|---|
DOMDocument::save | Serializes and saves the XML document to a file. |
DOMDocument::loadXML | Parses XML markup from a string. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Using this API without checking the required input or extension | Do not enable external entity loading for untrusted XML. The legacy DOMDocument HTML parser and the modern PHP 8.4 HTML parser follow different HTML parsing rules. |
| Confusing a detached node with one in the document | Append or import nodes into the intended owner document before querying the tree. |
| Loading untrusted XML with external entities enabled | Disable network entity loading and impose limits on input size. |
Key Takeaways
- Serializes and saves the XML document to a file.
- Do not enable external entity loading for untrusted XML. The legacy DOMDocument HTML parser and the modern PHP 8.4 HTML parser follow different HTML parsing rules.
- Test both the expected case and at least one failure or empty-input case before deployment.
Serializes and saves the XML document to a file. Use it when the operation fits your input, output and validation requirements.