simplexml_load_file
(PHP 5, PHP 7, PHP 8)
simplexml_load_file — Interprets an XML file into an object
Description
string
$filename,?string
$class_name = SimpleXMLElement::class,int
$options = 0,string
$namespace_or_prefix = "",bool
$is_prefix = false): SimpleXMLElement|false
Convert the well-formed XML document in the given file to an object.
Parameters
-
filename -
Path to the XML file
-
class_name -
You may use this optional parameter so that simplexml_load_file() will return an object of the specified class. That class should extend the SimpleXMLElement class.
-
options -
Since Libxml 2.6.0, you may also use the
optionsparameter to specify additional Libxml parameters. -
namespace_or_prefix -
Namespace prefix or URI.
-
is_prefix -
trueifnamespace_or_prefixis a prefix,falseif it's a URI; defaults tofalse.
Return Values
Returns an object of class SimpleXMLElement with
properties containing the data held within the XML document, or false on failure.
This function may
return Boolean false, but may also return a non-Boolean value which
evaluates to false. Please read the section on Booleans for more
information. Use the ===
operator for testing the return value of this
function.
Errors/Exceptions
Produces an E_WARNING error message for each error
found in the XML data.
Use libxml_use_internal_errors() to suppress all XML errors, and libxml_get_errors() to iterate over them afterwards.
Examples
Example #1 Interpret an XML document
<?php
// The file test.xml contains an XML document with a root element
// and at least an element /[root]/title.
if (file_exists('test.xml')) {
$xml = simplexml_load_file('test.xml');
print_r($xml);
} else {
exit('Failed to open test.xml.');
}
?>
This script will display, on success:
SimpleXMLElement Object ( [title] => Example Title ... )
At this point, you can go about using $xml->title
and any other elements.
See Also
- simplexml_load_string() - Interprets a string of XML into an object
- SimpleXMLElement::__construct() - Creates a new SimpleXMLElement object
- Dealing with XML errors
- libxml_use_internal_errors() - Disable libxml errors and allow user to fetch error information as needed
- Basic SimpleXML usage
- libxml_set_streams_context() - Set the streams context for the next libxml document load or write
