<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Interprets a string of XML into an object</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.simplexml-load-file.html">simplexml_load_file</a></div> <div class="next" style="text-align: right; float: right;"><a href="book.wddx.html">WDDX</a></div> <div class="up"><a href="ref.simplexml.html">SimpleXML Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.simplexml-load-string" class="refentry"> <div class="refnamediv"> <h1 class="refname">simplexml_load_string</h1> <p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">simplexml_load_string</span> — <span class="dc-title"> Interprets a string of XML into an object </span></p> </div> <div class="refsect1 description" id="refsect1-function.simplexml-load-string-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><a href="class.simplexmlelement.html" class="type SimpleXMLElement">SimpleXMLElement</a></span> <span class="methodname"><strong>simplexml_load_string</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$class_name</code><span class="initializer"> = "SimpleXMLElement"</span></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$ns</code><span class="initializer"> = ""</span></span> [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$is_prefix</code><span class="initializer"> = false</span></span> ]]]] )</div> <p class="para rdfs-comment"> Takes a well-formed XML string and returns it as an object. </p> </div> <div class="refsect1 parameters" id="refsect1-function.simplexml-load-string-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">data</code></em></span> <dd> <p class="para"> A well-formed XML string </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">class_name</code></em></span> <dd> <p class="para"> You may use this optional parameter so that <span class="function"><strong>simplexml_load_string()</strong></span> will return an object of the specified class. That class should extend the <span class="type"><a href="class.simplexmlelement.html" class="type SimpleXMLElement">SimpleXMLElement</a></span> class. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">options</code></em></span> <dd> <p class="para"> Since PHP 5.1.0 and Libxml 2.6.0, you may also use the <em><code class="parameter">options</code></em> parameter to specify <a href="libxml.constants.html" class="link">additional Libxml parameters</a>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">ns</code></em></span> <dd> <p class="para"> Namespace prefix or URI. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">is_prefix</code></em></span> <dd> <p class="para"> <strong><code>TRUE</code></strong> if <em><code class="parameter">ns</code></em> is a prefix, <strong><code>FALSE</code></strong> if it's a URI; defaults to <strong><code>FALSE</code></strong>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.simplexml-load-string-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns an <span class="type"><a href="language.types.object.html" class="type object">object</a></span> of class <span class="type"><a href="class.simplexmlelement.html" class="type SimpleXMLElement">SimpleXMLElement</a></span> with properties containing the data held within the xml document, or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 errors" id="refsect1-function.simplexml-load-string-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> Produces an <strong><code>E_WARNING</code></strong> error message for each error found in the XML data. </p> <div class="tip"><strong class="tip">Tip</strong> <p class="para"> Use <span class="function"><a href="function.libxml-use-internal-errors.html" class="function">libxml_use_internal_errors()</a></span> to suppress all XML errors, and <span class="function"><a href="function.libxml-get-errors.html" class="function">libxml_get_errors()</a></span> to iterate over them afterwards. </p> </div> </div> <div class="refsect1 examples" id="refsect1-function.simplexml-load-string-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-5522"> <p><strong>Example #1 Interpret an XML string</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$string </span><span style="color: #007700">= <<<XML<br /></span><span style="color: #DD0000"><?xml version='1.0'?> <br /><document><br /> <title>Forty What?</title><br /> <from>Joe</from><br /> <to>Jane</to><br /> <body><br /> I know that's the answer -- but what's the question?<br /> </body><br /></document><br /></span><span style="color: #007700">XML;<br /><br /></span><span style="color: #0000BB">$xml </span><span style="color: #007700">= </span><span style="color: #0000BB">simplexml_load_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$string</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$xml</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> SimpleXMLElement Object ( [title] => Forty What? [from] => Joe [to] => Jane [body] => I know that's the answer -- but what's the question? ) </pre></div> </div> <div class="example-contents"><p> At this point, you can go about using <em>$xml->body</em> and such. </p></div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.simplexml-load-string-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.simplexml-load-file.html" class="function" rel="rdfs-seeAlso">simplexml_load_file()</a> - Interprets an XML file into an object</span></li> <li class="member"> <span class="methodname"><a href="simplexmlelement.construct.html" class="methodname" rel="rdfs-seeAlso">SimpleXMLElement::__construct()</a> - Creates a new SimpleXMLElement object</span></li> <li class="member"><a href="simplexml.examples-errors.html" class="xref">Dealing with XML errors</a></li> <li class="member"> <span class="function"><a href="function.libxml-use-internal-errors.html" class="function" rel="rdfs-seeAlso">libxml_use_internal_errors()</a> - Disable libxml errors and allow user to fetch error information as needed</span></li> <li class="member"><a href="simplexml.examples-basic.html" class="xref">Basic SimpleXML usage</a></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.simplexml-load-file.html">simplexml_load_file</a></div> <div class="next" style="text-align: right; float: right;"><a href="book.wddx.html">WDDX</a></div> <div class="up"><a href="ref.simplexml.html">SimpleXML Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>