<!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>Generates a user-level error/warning/notice message</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.set-exception-handler.html">set_exception_handler</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.user-error.html">user_error</a></div>
<div class="up"><a href="ref.errorfunc.html">Error Handling Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.trigger-error" class="refentry">
<div class="refnamediv">
<h1 class="refname">trigger_error</h1>
<p class="verinfo">(PHP 4 >= 4.0.1, PHP 5)</p><p class="refpurpose"><span class="refname">trigger_error</span> — <span class="dc-title">Generates a user-level error/warning/notice message</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.trigger-error-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>trigger_error</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$error_msg</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$error_type</code><span class="initializer"> = E_USER_NOTICE</span></span>
] )</div>
<p class="para rdfs-comment">
Used to trigger a user error condition, it can be used in conjunction
with the built-in error handler, or with a user defined function that has
been set as the new error handler
( <span class="function"><a href="function.set-error-handler.html" class="function">set_error_handler()</a></span>).
</p>
<p class="para">
This function is useful when you need to generate a particular response to
an exception at runtime.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.trigger-error-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">error_msg</code></em></span>
<dd>
<p class="para">
The designated error message for this error. It's limited to 1024
bytes in length. Any additional characters beyond 1024 bytes will be
truncated.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">error_type</code></em></span>
<dd>
<p class="para">
The designated error type for this error. It only works with the E_USER
family of constants, and will default to <strong><code>E_USER_NOTICE</code></strong>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.trigger-error-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This function returns <strong><code>FALSE</code></strong> if wrong <em><code class="parameter">error_type</code></em> is
specified, <strong><code>TRUE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.trigger-error-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-458">
<p><strong>Example #1 <span class="function"><strong>trigger_error()</strong></span> example</strong></p>
<div class="example-contents"><p>
See <span class="function"><a href="function.set-error-handler.html" class="function">set_error_handler()</a></span> for a more extensive example.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">$divisor </span><span style="color: #007700">== </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">trigger_error</span><span style="color: #007700">(</span><span style="color: #DD0000">"Cannot divide by zero"</span><span style="color: #007700">, </span><span style="color: #0000BB">E_USER_ERROR</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.trigger-error-notes">
<h3 class="title">Notes</h3>
<div class="warning"><strong class="warning">Warning</strong>
<p class="para">
HTML entities in <em><code class="parameter">error_msg</code></em> are not
escaped. Use <span class="function"><a href="function.htmlentities.html" class="function">htmlentities()</a></span> on the message if
the error is to be displayed in a browser.
</p>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-function.trigger-error-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.error-reporting.html" class="function" rel="rdfs-seeAlso">error_reporting()</a> - Sets which PHP errors are reported</span></li>
<li class="member"> <span class="function"><a href="function.set-error-handler.html" class="function" rel="rdfs-seeAlso">set_error_handler()</a> - Sets a user-defined error handler function</span></li>
<li class="member"> <span class="function"><a href="function.restore-error-handler.html" class="function" rel="rdfs-seeAlso">restore_error_handler()</a> - Restores the previous error handler function</span></li>
<li class="member">The <a href="errorfunc.constants.html" class="link">error level constants</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.set-exception-handler.html">set_exception_handler</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.user-error.html">user_error</a></div>
<div class="up"><a href="ref.errorfunc.html">Error Handling Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
