<!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>Register given function as __autoload() implementation</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.spl-autoload-functions.html">spl_autoload_functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.spl-autoload-unregister.html">spl_autoload_unregister</a></div>
<div class="up"><a href="ref.spl.html">SPL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.spl-autoload-register" class="refentry">
<div class="refnamediv">
<h1 class="refname">spl_autoload_register</h1>
<p class="verinfo">(PHP 5 >= 5.1.2)</p><p class="refpurpose"><span class="refname">spl_autoload_register</span> — <span class="dc-title">Register given function as __autoload() implementation</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.spl-autoload-register-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>spl_autoload_register</strong></span>
([ <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$autoload_function</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$throw</code><span class="initializer"> = true</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$prepend</code><span class="initializer"> = false</span></span>
]]] )</div>
<p class="para rdfs-comment">
Register a function with the spl provided __autoload stack. If the stack
is not yet activated it will be activated.
</p>
<p class="para">
If your code has an existing <span class="function"><a href="function.autoload.html" class="function">__autoload()</a></span> function then
this function must be explicitly registered on the __autoload stack. This
is because <span class="function"><strong>spl_autoload_register()</strong></span> will effectively
replace the engine cache for the <span class="function"><a href="function.autoload.html" class="function">__autoload()</a></span> function
by either <span class="function"><a href="function.spl-autoload.html" class="function">spl_autoload()</a></span> or
<span class="function"><a href="function.spl-autoload-call.html" class="function">spl_autoload_call()</a></span>.
</p>
<p class="para">
If there must be multiple autoload functions, <span class="function"><strong>spl_autoload_register()</strong></span>
allows for this. It effectively creates a queue of autoload functions, and
runs through each of them in the order they are defined. By contrast,
<span class="function"><a href="function.autoload.html" class="function">__autoload()</a></span> may only be defined once.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.spl-autoload-register-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">autoload_function</code></em></span>
<dd>
<p class="para">
The autoload function being registered.
If no parameter is provided, then the default implementation of
<span class="function"><a href="function.spl-autoload.html" class="function">spl_autoload()</a></span> will be registered.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">throw</code></em></span>
<dd>
<p class="para">
This parameter specifies whether
<span class="function"><strong>spl_autoload_register()</strong></span> should throw
exceptions when the <em><code class="parameter">autoload_function</code></em>
cannot be registered.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">prepend</code></em></span>
<dd>
<p class="para">
If true, <span class="function"><strong>spl_autoload_register()</strong></span> will prepend
the autoloader on the autoload stack instead of appending it.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.spl-autoload-register-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.spl-autoload-register-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>5.3.0</td>
<td>
Namespaces support was introduced.
</td>
</tr>
<tr>
<td>5.3.0</td>
<td>
The <em><code class="parameter">prepend</code></em> parameter was added.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.spl-autoload-register-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3918">
<p><strong>Example #1 <span class="function"><strong>spl_autoload_register()</strong></span> as a replacement for an <span class="function"><a href="function.autoload.html" class="function">__autoload()</a></span> function</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// function __autoload($class) {<br />// include 'classes/' . $class . '.class.php';<br />// }<br /><br /></span><span style="color: #007700">function </span><span style="color: #0000BB">my_autoloader</span><span style="color: #007700">(</span><span style="color: #0000BB">$class</span><span style="color: #007700">) {<br /> include </span><span style="color: #DD0000">'classes/' </span><span style="color: #007700">. </span><span style="color: #0000BB">$class </span><span style="color: #007700">. </span><span style="color: #DD0000">'.class.php'</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">spl_autoload_register</span><span style="color: #007700">(</span><span style="color: #DD0000">'my_autoloader'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Or, using an anonymous function as of PHP 5.3.0<br /></span><span style="color: #0000BB">spl_autoload_register</span><span style="color: #007700">(function (</span><span style="color: #0000BB">$class</span><span style="color: #007700">) {<br /> include </span><span style="color: #DD0000">'classes/' </span><span style="color: #007700">. </span><span style="color: #0000BB">$class </span><span style="color: #007700">. </span><span style="color: #DD0000">'.class.php'</span><span style="color: #007700">;<br />});<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-3919">
<p><strong>Example #2 <span class="function"><strong>spl_autoload_register()</strong></span> example where the class is not loaded</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">namespace </span><span style="color: #0000BB">Foobar</span><span style="color: #007700">;<br /><br />class </span><span style="color: #0000BB">Foo </span><span style="color: #007700">{<br /> static public function </span><span style="color: #0000BB">test</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">) {<br /> print </span><span style="color: #DD0000">'[['</span><span style="color: #007700">. </span><span style="color: #0000BB">$name </span><span style="color: #007700">.</span><span style="color: #DD0000">']]'</span><span style="color: #007700">;<br /> }<br />}<br /><br /></span><span style="color: #0000BB">spl_autoload_register</span><span style="color: #007700">(</span><span style="color: #0000BB">__NAMESPACE__ </span><span style="color: #007700">.</span><span style="color: #DD0000">'\Foo::test'</span><span style="color: #007700">); </span><span style="color: #FF8000">// As of PHP 5.3.0<br /><br /></span><span style="color: #007700">new </span><span style="color: #0000BB">InexistentClass</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
[[Foobar\InexistentClass]]
Fatal error: Class 'Foobar\InexistentClass' not found in ...
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.spl-autoload-register-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.autoload.html" class="function" rel="rdfs-seeAlso">__autoload()</a> - Attempt to load undefined class</span></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.spl-autoload-functions.html">spl_autoload_functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.spl-autoload-unregister.html">spl_autoload_unregister</a></div>
<div class="up"><a href="ref.spl.html">SPL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
