Source of: /manual/en/function.sleep.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.misc.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.sleep.php',
1 => 'sleep',
),
'up' =>
array (
0 => 'ref.misc.php',
1 => 'Misc. Functions',
),
'prev' =>
array (
0 => 'function.show-source.php',
1 => 'show_source',
),
'next' =>
array (
0 => 'function.sys-getloadavg.php',
1 => 'sys_getloadavg',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.sleep" class="refentry">
<div class="refnamediv">
<h1 class="refname">sleep</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">sleep</span> — <span class="dc-title">Delay execution</span></p>
</div>
<a name="function.sleep.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>sleep</b></span>
( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$seconds</tt></span>
)</div>
<p class="simpara">
Delays the program execution for the given number of
<i><tt class="parameter">seconds</tt></i>
.
</p>
</div>
<a name="function.sleep.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">seconds</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Halt time in seconds.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.sleep.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns zero on success, or <b><tt class="constant">FALSE</tt></b> on errors. If the call was interrupted
by a signal, <b>sleep()</b> returns the number of seconds left
to sleep.
</p>
</div>
<a name="function.sleep.errors"></a><div class="refsect1 errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
If the specified number of <i><tt class="parameter">seconds</tt></i>
is negative,
this function will generate a <b><tt class="constant">E_WARNING</tt></b>.
</p>
</div>
<a name="function.sleep.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>sleep()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// current time<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">date</span><span style="color: #007700">(</span><span style="color: #DD0000">'h:i:s'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// sleep for 10 seconds<br /></span><span style="color: #0000BB">sleep</span><span style="color: #007700">(</span><span style="color: #0000BB">10</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// wake up !<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">date</span><span style="color: #007700">(</span><span style="color: #DD0000">'h:i:s'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>
This example will output (after 10 seconds)
</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
05:31:23
05:31:33
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.sleep.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.usleep.php" class="function" rel="rdfs-seeAlso">usleep()</a> - Delay execution in microseconds</li>
<li class="member"><a href="function.time-nanosleep.php" class="function" rel="rdfs-seeAlso">time_nanosleep()</a> - Delay for a number of seconds and nanoseconds</li>
<li class="member"><a href="function.time-sleep-until.php" class="function" rel="rdfs-seeAlso">time_sleep_until()</a> - Make the script sleep until the specified time</li>
<li class="member"><a href="function.set-time-limit.php" class="function" rel="rdfs-seeAlso">set_time_limit()</a> - Limits the maximum execution time</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
