<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.errorfunc.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.trigger-error.php',
    1 => 'trigger_error',
    2 => '产生一个用户级别的 error/warning/notice 信息',
  ),
  'up' => 
  array (
    0 => 'ref.errorfunc.php',
    1 => '错误处理 函数',
  ),
  'prev' => 
  array (
    0 => 'function.set-exception-handler.php',
    1 => 'set_exception_handler',
  ),
  'next' => 
  array (
    0 => 'function.user-error.php',
    1 => 'user_error',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/errorfunc/functions/trigger-error.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.trigger-error" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">trigger_error</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.1, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">trigger_error</span> &mdash; <span class="dc-title">产生一个用户级别的 error/warning/notice 信息</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.trigger-error-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>trigger_error</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$message</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$error_level</code><span class="initializer"> = <strong><code><a href="errorfunc.constants.php#constant.e-user-notice">E_USER_NOTICE</a></code></strong></span></span>): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>

  <p class="para rdfs-comment">
   用于触发一个用户级别的错误条件，它能结合内置的错误处理器所关联，或者可以使用用户定义的函数作为新的错误处理程序(<span class="function"><a href="function.set-error-handler.php" class="function">set_error_handler()</a></span>)。
  </p>
  <p class="para">
   该函数在你运行出现异常时，需要产生一个特定的响应时非常有用。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.trigger-error-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">message</code></dt>
     <dd>
      <p class="para">
       该 error 的特定错误信息，长度限制在了 1024 个字节。超过 1024 字节的字符都会被截断。
      </p>
     </dd>
    
    
     <dt><code class="parameter">error_level</code></dt>
     <dd>
      <p class="para">
       该 error 所特定的错误类型。仅 <strong><code><a href="errorfunc.constants.php#constant.e-user-error">E_USER_<span class="replaceable">*</span></a></code></strong> 系列常量对其有效，默认是 <strong><code><a href="errorfunc.constants.php#constant.e-user-notice">E_USER_NOTICE</a></code></strong>。
      </p>
      <div class="warning"><strong class="warning">警告</strong>
       <p class="simpara">
        现已弃用传递 <strong><code><a href="errorfunc.constants.php#constant.e-user-error">E_USER_ERROR</a></code></strong> 作为 <code class="parameter">error_level</code>。抛出
        <span class="exceptionname"><a href="class.exception.php" class="exceptionname">Exception</a></span> 或调用 <span class="function"><a href="function.exit.php" class="function">exit()</a></span>。
       </p>
      </div>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.trigger-error-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   总是返回 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.trigger-error-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
   如果 <code class="parameter">error_level</code> 不是 <strong><code><a href="errorfunc.constants.php#constant.e-user-error">E_USER_ERROR</a></code></strong>、<strong><code><a href="errorfunc.constants.php#constant.e-user-warning">E_USER_WARNING</a></code></strong>、<strong><code><a href="errorfunc.constants.php#constant.e-user-notice">E_USER_NOTICE</a></code></strong>
   或 <strong><code><a href="errorfunc.constants.php#constant.e-user-deprecated">E_USER_DEPRECATED</a></code></strong>，此函数将抛出 <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>。
  </p>
 </div>


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

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.4.0</td>
      <td>
       现已弃用传递 <strong><code><a href="errorfunc.constants.php#constant.e-user-error">E_USER_ERROR</a></code></strong> 作为 <code class="parameter">error_level</code>。抛出
       <span class="exceptionname"><a href="class.exception.php" class="exceptionname">Exception</a></span> 或调用 <span class="function"><a href="function.exit.php" class="function">exit()</a></span>。
      </td>
     </tr>

     <tr>
      <td>8.4.0</td>
      <td>
       此函数现在返回类型是 <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span> 而不是 <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>。
      </td>
     </tr>

     <tr>
      <td>8.0.0</td>
      <td>
       如果指定 <code class="parameter">error_level</code> 无效，此函数现在将抛出 <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>。之前返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.trigger-error-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1 <span class="function"><strong>trigger_error()</strong></span> 示例</strong></p>
    <div class="example-contents"><p>
     <span class="function"><a href="function.set-error-handler.php" class="function">set_error_handler()</a></span> 可见到更多详细的例子。
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$password </span><span style="color: #007700">= </span><span style="color: #0000BB">$_POST</span><span style="color: #007700">[</span><span style="color: #DD0000">'password'</span><span style="color: #007700">] ?? </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">$password </span><span style="color: #007700">=== </span><span style="color: #DD0000">''</span><span style="color: #007700">) {<br />  </span><span style="color: #0000BB">trigger_error</span><span style="color: #007700">(</span><span style="color: #DD0000">"Using an empty password is unsafe"</span><span style="color: #007700">, </span><span style="color: #0000BB">E_USER_WARNING</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">$hash </span><span style="color: #007700">= </span><span style="color: #0000BB">password_hash</span><span style="color: #007700">(</span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">PASSWORD_DEFAULT</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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


 <div class="refsect1 notes" id="refsect1-function.trigger-error-notes">
  <h3 class="title">注释</h3>
  <div class="warning"><strong class="warning">警告</strong>
   <p class="para">
     在 <code class="parameter">message</code> 
     里的 HTML 实体，并不会被转义。如果错误消息要显示在浏览器里，需要对错误消息使用
     <span class="function"><a href="function.htmlentities.php" class="function">htmlentities()</a></span>。
   </p>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.trigger-error-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.error-reporting.php" class="function" rel="rdfs-seeAlso">error_reporting()</a> - 设置应该报告何种 PHP 错误</span></li>
    <li><span class="function"><a href="function.set-error-handler.php" class="function" rel="rdfs-seeAlso">set_error_handler()</a> - 设置用户自定义的错误处理函数</span></li>
    <li><span class="function"><a href="function.restore-error-handler.php" class="function" rel="rdfs-seeAlso">restore_error_handler()</a> - 还原之前的错误处理函数</span></li>
    <li><a href="errorfunc.constants.php" class="link">错误级别常量</a></li>
    <li><span class="classname"><a href="class.deprecated.php" class="classname">Deprecated</a></span> 注解</li>
   </ul>
  </p>
 </div>

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