<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.var.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.unserialize.php',
    1 => 'unserialize',
    2 => '从已存储的表示中创建 PHP 的值',
  ),
  'up' => 
  array (
    0 => 'ref.var.php',
    1 => '变量处理函数',
  ),
  'prev' => 
  array (
    0 => 'function.strval.php',
    1 => 'strval',
  ),
  'next' => 
  array (
    0 => 'function.unset.php',
    1 => 'unset',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/var/functions/unserialize.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.unserialize" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">unserialize</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">unserialize</span> &mdash; <span class="dc-title">
   从已存储的表示中创建 PHP 的值
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.unserialize-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>unserialize</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = []</span></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

  <p class="simpara">
   <span class="function"><strong>unserialize()</strong></span> 对单一的已序列化的变量进行操作，将其转换回 
   PHP 的值。
  </p>
  <div class="warning"><strong class="warning">警告</strong>
   <p class="para">
    无论 <code class="literal">allowed_classes</code> 的 <code class="parameter">options</code>
    值如何，都不要将不受信任的用户输入传递给
    <span class="function"><strong>unserialize()</strong></span>。由于对象实例化和自动加载，反序列化可能会导致加载代码并执行，恶意用户可能会利用这一点。如果需要将序列化数据传递给用户，请使用安全、标准的数据交换格式，例如
    JSON（通过 <span class="function"><a href="function.json-decode.php" class="function">json_decode()</a></span> 和 <span class="function"><a href="function.json-encode.php" class="function">json_encode()</a></span>）。
   </p>
   <p class="para">
    如果需要反序列化外部存储的序列化数据，请考虑使用 <span class="function"><a href="function.hash-hmac.php" class="function">hash_hmac()</a></span> 做数据验证。确保数据不会被任何人修改。
   </p>
  </div>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.unserialize-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">data</code></dt>
     <dd>
      <p class="para">
       序列化后的字符串。
      </p>
      <p class="para">
       若被反序列化的变量是一个对象，在成功地重新构造对象之后，PHP 会试图自动调用
       <a href="language.oop5.magic.php#object.unserialize" class="link">__unserialize()</a> 或
       <a href="language.oop5.magic.php#object.wakeup" class="link">__wakeup()</a> 方法（如果存在）。
      </p>
      <p class="para">
       <blockquote class="note"><p><strong class="note">注意</strong>: 
        <strong>
         <a href="var.configuration.php#ini.unserialize-callback-func" class="link">unserialize_callback_func</a>
          指令
        </strong><br />
        <p class="para">
         在反序列化未定义类时会调用 <a href="var.configuration.php#ini.unserialize-callback-func" class="link">unserialize_callback_func</a>
         指令中指定的回调。如果没有指定回调，将对象实例化为 <span class="classname"><a href="class.php-incomplete-class.php" class="classname">__PHP_Incomplete_Class</a></span>。
        </p>
       </p></blockquote>
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       使用关联数组提供给 <span class="function"><strong>unserialize()</strong></span> 的任何选项。
      </p>
      <table class="doctable table">
       <caption><strong>可用选项</strong></caption>
       
        <thead>
         <tr>
          <th>名称</th>
          <th>类型</th>
          <th>说明</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td><code class="literal">allowed_classes</code></td>
          <td><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></td>
          <td>
           <span class="simpara">
            应该接受的类名数组，<strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> 表示不接受任何类，或者 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> 表示接受所有类。如果定义此选项且
            <span class="function"><strong>unserialize()</strong></span> 遇到不接受的类的对象，则该对象将会实例化为
            <span class="classname"><a href="class.php-incomplete-class.php" class="classname">__PHP_Incomplete_Class</a></span>。
           </span>
           <span class="simpara">
            省略此选项等同于定义为 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>：PHP 将会尝试实例化任何类的对象。
           </span>
          </td>
         </tr>

         <tr>
          <td><code class="literal">max_depth</code></td>
          <td><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></td>
          <td>
           <span class="simpara">
            反序列时允许的最大结构深度，主要为了防止栈溢出。默认深度限制为 <code class="literal">4096</code>，可以通过将
            <code class="literal">max_depth</code> 设置为 <code class="literal">0</code> 来禁用。
           </span>
          </td>
         </tr>

        </tbody>
       
      </table>

     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.unserialize-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   返回的是转换之后的值，可为 <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>、<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>、<span class="type"><a href="language.types.float.php" class="type float">float</a></span>、<span class="type"><a href="language.types.string.php" class="type string">string</a></span>、<span class="type"><a href="language.types.array.php" class="type array">array</a></span>
   或 <span class="type"><a href="language.types.object.php" class="type object">object</a></span>。
  </p>
  <p class="para">
   如果传递的字符串不可反序列化，则返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>，并产生 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.unserialize-errors">
  <h3 class="title">错误／异常</h3>
  <p class="simpara">
   对象可能会在反序列化处理程序中抛出 <span class="classname"><a href="class.throwable.php" class="classname">Throwable</a></span>。
  </p>
  <p class="simpara">
   自 PHP 8.4.0 起，如果 <code class="parameter">options</code> 的 <code class="literal">allowed_classes</code>
   元素不是类名 <span class="type"><a href="language.types.array.php" class="type array">array</a></span>，则 <span class="function"><strong>unserialize()</strong></span> 会抛出 <span class="exceptionname"><a href="class.typeerror.php" class="exceptionname">TypeError</a></span>
   和 <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span>。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.unserialize-changelog">
  <h3 class="title">更新日志</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>版本</th>
       <th>说明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.4.0</td>
       <td>
        如果 <code class="parameter">options</code> 的 <code class="literal">allowed_classes</code>
        元素不是类名 <span class="type"><a href="language.types.array.php" class="type array">array</a></span>，现在会抛出 <span class="exceptionname"><a href="class.typeerror.php" class="exceptionname">TypeError</a></span>
        和 <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span>。
       </td>
      </tr>

      <tr>
       <td>8.3.0</td>
       <td>
        当输入字符串有未使用的数据时，现在会发出 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>。
       </td>
      </tr>

      <tr>
       <td>8.3.0</td>
       <td>
        当传递的字符串有未消耗的数据时，现在会发出 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>。
       </td>
      </tr>

      <tr>
       <td>8.3.0</td>
       <td>
        当传递的字符串不可序列化时，现在抛出 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>；
        之前是抛出 <span class="classname"><strong class="classname">E_NOTICE</strong></span>。
       </td>
      </tr>

      <tr>
       <td>7.4.0</td>
       <td>
        新增 <code class="parameter">options</code> 的 <code class="literal">max_depth</code> 元素，设置反序列化时允许的最大结构深度。
       </td>
      </tr>

      <tr>
       <td>7.1.0</td>
       <td>
        <code class="parameter">options</code> 的 <code class="literal">allowed_classes</code> 元素现在是严格类型，即如果给出
        <span class="type"><a href="language.types.array.php" class="type array">array</a></span> 或 <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> 以外的任何内容，则 <span class="function"><strong>unserialize()</strong></span> 返回
        <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> 并发出 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.unserialize-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1 <span class="function"><strong>unserialize()</strong></span> 示例</strong></p>
    <div class="example-contents">
<div class="annotation-non-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// 这里，我们使用 unserialize() 装载来自数据库的 $session_data 数组中的会话数据。<br />// 此例是描述 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">// 如果执行出错或返回错误，则初始化为空数组<br />    </span><span style="color: #0000BB">$session_data </span><span style="color: #007700">= array();<br />} else {<br />    </span><span style="color: #FF8000">// 现在我们需要的是 $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">// 出错，初始化为空数组<br />        </span><span style="color: #0000BB">$session_data </span><span style="color: #007700">= array();<br />    }<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
  <p class="para">
   <div class="example" id="example-2">
    <p><strong>示例 #2 unserialize_callback_func 示例</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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: #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">// 设置回调函数<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">// 只需包含含有类定义的文件<br />   // $classname 指出需要的是哪一个类<br />   </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$classname</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">unserialize</span><span style="color: #007700">(</span><span style="color: #0000BB">$serialized_object</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.unserialize-notes">
  <h3 class="title">注释</h3>
  <div class="warning"><strong class="warning">警告</strong>
   <p class="para">
    如果发生了错误或反序列化了已序列化的 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> 值，则会返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。可以通过 <code class="parameter">data</code> 和
    <code class="literal">serialize(false)</code> 进行比较，或者捕捉 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> 错误来判断这种特殊情况。
   </p>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.unserialize-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.json-encode.php" class="function" rel="rdfs-seeAlso">json_encode()</a> - 对变量进行 JSON 编码</span></li>
    <li><span class="function"><a href="function.json-decode.php" class="function" rel="rdfs-seeAlso">json_decode()</a> - 对 JSON 格式的字符串进行解码</span></li>
    <li><span class="function"><a href="function.hash-hmac.php" class="function" rel="rdfs-seeAlso">hash_hmac()</a> - 使用 HMAC 方法生成带有密钥的散列值</span></li>
    <li><span class="function"><a href="function.serialize.php" class="function" rel="rdfs-seeAlso">serialize()</a> - 生成值的可存储表示</span></li>
    <li><a href="language.oop5.autoload.php" class="link">自动加载类</a></li>
    <li><a href="var.configuration.php#ini.unserialize-callback-func" class="link">unserialize_callback_func</a></li>
    <li><a href="var.configuration.php#ini.unserialize-max-depth" class="link">unserialize_max_depth</a></li>
    <li><a href="language.oop5.magic.php#object.wakeup" class="link">__wakeup()</a></li>
    <li><a href="language.oop5.magic.php#object.serialize" class="link">__serialize()</a></li>
    <li><a href="language.oop5.magic.php#object.unserialize" class="link">__unserialize()</a></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>