<!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>Removes directory</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.rewind.html">rewind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.set-file-buffer.html">set_file_buffer</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.rmdir" class="refentry">
<div class="refnamediv">
<h1 class="refname">rmdir</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">rmdir</span> — <span class="dc-title">Removes directory</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.rmdir-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>rmdir</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$dirname</code></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code></span>
] )</div>
<p class="para rdfs-comment">
Attempts to remove the directory named by <em><code class="parameter">dirname</code></em>.
The directory must be empty, and the relevant permissions must permit this.
A <strong><code>E_WARNING</code></strong> level error will be generated on failure.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.rmdir-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">dirname</code></em></span>
<dd>
<p class="para">
Path to the directory.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">context</code></em></span>
<dd>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">Context support was added
with PHP 5.0.0. For a description of <em>contexts</em>, refer to
<a href="book.stream.html" class="xref">Streams</a>.</span></p></blockquote>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.rmdir-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.rmdir-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.0.0</td>
<td>
As of PHP 5.0.0 <span class="function"><strong>rmdir()</strong></span> can also be used with
<em class="emphasis">some</em> URL wrappers. Refer to <a href="wrappers.html" class="xref">Supported Protocols and Wrappers</a> for a listing of which wrappers support
<span class="function"><strong>rmdir()</strong></span>.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.rmdir-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2430">
<p><strong>Example #1 <span class="function"><strong>rmdir()</strong></span> example</strong></p>
<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">is_dir</span><span style="color: #007700">(</span><span style="color: #DD0000">'examples'</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">mkdir</span><span style="color: #007700">(</span><span style="color: #DD0000">'examples'</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">rmdir</span><span style="color: #007700">(</span><span style="color: #DD0000">'examples'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.rmdir-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">When <a href="features.safe-mode.html" class="link">safe mode</a> is enabled, PHP checks whether
the directory in which the script is operating has the same UID (owner) as the
script that is being executed.</span></p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.rmdir-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.is-dir.html" class="function" rel="rdfs-seeAlso">is_dir()</a> - Tells whether the filename is a directory</span></li>
<li class="member"> <span class="function"><a href="function.mkdir.html" class="function" rel="rdfs-seeAlso">mkdir()</a> - Makes directory</span></li>
<li class="member"> <span class="function"><a href="function.unlink.html" class="function" rel="rdfs-seeAlso">unlink()</a> - Deletes a file</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.rewind.html">rewind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.set-file-buffer.html">set_file_buffer</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
