<!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>Creates a PHP value from a stored representation</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.strval.html">strval</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.unset.html">unset</a></div> <div class="up"><a href="ref.var.html">Variable handling Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.unserialize" class="refentry"> <div class="refnamediv"> <h1 class="refname">unserialize</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">unserialize</span> — <span class="dc-title"> Creates a PHP value from a stored representation </span></p> </div> <div class="refsect1 description" id="refsect1-function.unserialize-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>unserialize</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span> )</div> <p class="simpara"> <span class="function"><strong>unserialize()</strong></span> takes a single serialized variable and converts it back into a PHP value. </p> </div> <div class="refsect1 parameters" id="refsect1-function.unserialize-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">str</code></em></span> <dd> <p class="para"> The serialized string. </p> <p class="para"> If the variable being unserialized is an object, after successfully reconstructing the object PHP will automatically attempt to call the <a href="language.oop5.magic.html#object.wakeup" class="link">__wakeup()</a> member function (if it exists). </p> <p class="para"> <blockquote class="note"><p><strong class="note">Note</strong>: <strong>unserialize_callback_func directive</strong><br /> <p class="para"> It's possible to set a callback-function which will be called, if an undefined class should be instantiated during unserializing. (to prevent getting an incomplete <span class="type"><a href="language.types.object.html" class="type object">object</a></span> "__PHP_Incomplete_Class".) Use your <var class="filename">php.ini</var>, <span class="function"><a href="function.ini-set.html" class="function">ini_set()</a></span> or <var class="filename">.htaccess</var> to define '<em>unserialize_callback_func</em>'. Everytime an undefined class should be instantiated, it'll be called. To disable this feature just empty this setting. </p> </p></blockquote> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.unserialize-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> The converted value is returned, and can be a <span class="type"><a href="language.types.boolean.html" class="type boolean">boolean</a></span>, <span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>, <span class="type"><a href="language.types.float.html" class="type float">float</a></span>, <span class="type"><a href="language.types.string.html" class="type string">string</a></span>, <span class="type"><a href="language.types.array.html" class="type array">array</a></span> or <span class="type"><a href="language.types.object.html" class="type object">object</a></span>. </p> <p class="para"> In case the passed string is not unserializeable, <strong><code>FALSE</code></strong> is returned and <strong><code>E_NOTICE</code></strong> is issued. </p> </div> <div class="refsect1 changelog" id="refsect1-function.unserialize-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>4.2.0</td> <td> The directive unserialize_callback_func became available. </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 examples" id="refsect1-function.unserialize-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-5274"> <p><strong>Example #1 <span class="function"><strong>unserialize()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Here, we use unserialize() to load session data to the<br />// $session_data array from the string selected from a database.<br />// This example complements the one described with serialize().<br /><br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">odbc_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"webdb"</span><span style="color: #007700">, </span><span style="color: #DD0000">"php"</span><span style="color: #007700">, </span><span style="color: #DD0000">"chicken"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">odbc_prepare</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"SELECT data FROM sessions WHERE id = ?"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$sqldata </span><span style="color: #007700">= array(</span><span style="color: #0000BB">$_SERVER</span><span style="color: #007700">[</span><span style="color: #DD0000">'PHP_AUTH_USER'</span><span style="color: #007700">]);<br />if (!</span><span style="color: #0000BB">odbc_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #0000BB">$sqldata</span><span style="color: #007700">) || !</span><span style="color: #0000BB">odbc_fetch_into</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #0000BB">$tmp</span><span style="color: #007700">)) {<br /> </span><span style="color: #FF8000">// if the execute or fetch fails, initialize to empty array<br /> </span><span style="color: #0000BB">$session_data </span><span style="color: #007700">= array();<br />} else {<br /> </span><span style="color: #FF8000">// we should now have the serialized data in $tmp[0].<br /> </span><span style="color: #0000BB">$session_data </span><span style="color: #007700">= </span><span style="color: #0000BB">unserialize</span><span style="color: #007700">(</span><span style="color: #0000BB">$tmp</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">]);<br /> if (!</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$session_data</span><span style="color: #007700">)) {<br /> </span><span style="color: #FF8000">// something went wrong, initialize to empty array<br /> </span><span style="color: #0000BB">$session_data </span><span style="color: #007700">= array();<br /> }<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> <p class="para"> <div class="example" id="example-5275"> <p><strong>Example #2 unserialize_callback_func example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$serialized_object</span><span style="color: #007700">=</span><span style="color: #DD0000">'O:1:"a":1:{s:5:"value";s:3:"100";}'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// unserialize_callback_func directive available as of PHP 4.2.0<br /></span><span style="color: #0000BB">ini_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'unserialize_callback_func'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mycallback'</span><span style="color: #007700">); </span><span style="color: #FF8000">// set your callback_function<br /><br /></span><span style="color: #007700">function </span><span style="color: #0000BB">mycallback</span><span style="color: #007700">(</span><span style="color: #0000BB">$classname</span><span style="color: #007700">) <br />{<br /> </span><span style="color: #FF8000">// just include a file containing your classdefinition<br /> // you get $classname to figure out which classdefinition is required<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 notes" id="refsect1-function.unserialize-notes"> <h3 class="title">Notes</h3> <div class="warning"><strong class="warning">Warning</strong> <p class="para"> <strong><code>FALSE</code></strong> is returned both in the case of an error and if unserializing the serialized <strong><code>FALSE</code></strong> value. It is possible to catch this special case by comparing <em><code class="parameter">str</code></em> with <em>serialize(false)</em> or by catching the issued <strong><code>E_NOTICE</code></strong>. </p> </div> <div class="warning"><strong class="warning">Warning</strong> <p class="para"> Do not pass untrusted user input to <span class="function"><strong>unserialize()</strong></span>. Unserialization can result in code being loaded and executed due to object instantiation and autoloading, and a malicious user may be able to exploit this. Use a safe, standard data interchange format such as JSON (via <span class="function"><a href="function.json-decode.html" class="function">json_decode()</a></span> and <span class="function"><a href="function.json-encode.html" class="function">json_encode()</a></span>) if you need to pass serialized data to the user. </p> </div> </div> <div class="refsect1 seealso" id="refsect1-function.unserialize-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.serialize.html" class="function" rel="rdfs-seeAlso">serialize()</a> - Generates a storable representation of a value</span></li> <li class="member"><a href="language.oop5.autoload.html" class="link">Autoloading Objects</a></li> <li class="member"><a href="var.configuration.html#unserialize-callback-func" class="link">unserialize_callback_func</a></li> <li class="member"><a href="language.oop5.magic.html#object.wakeup" class="link">__wakeup()</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.strval.html">strval</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.unset.html">unset</a></div> <div class="up"><a href="ref.var.html">Variable handling Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>