<!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>Tells whether the filename is a directory</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.glob.html">glob</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.is-executable.html">is_executable</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.is-dir" class="refentry">
<div class="refnamediv">
<h1 class="refname">is_dir</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">is_dir</span> — <span class="dc-title">Tells whether the filename is a directory</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.is-dir-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>is_dir</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
)</div>
<p class="para rdfs-comment">
Tells whether the given filename is a directory.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.is-dir-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
Path to the file. If <em><code class="parameter">filename</code></em> is a relative
filename, it will be checked relative to the current working
directory. If <em><code class="parameter">filename</code></em> is a symbolic or hard link
then the link will be resolved and checked. If you have enabled <a href="ini.sect.safe-mode.html#ini.safe-mode" class="link">safe mode</a>,
or <a href="ini.core.html#ini.open-basedir" class="link">open_basedir</a> further
restrictions may apply.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.is-dir-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the filename exists and is a directory, <strong><code>FALSE</code></strong>
otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.is-dir-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2399">
<p><strong>Example #1 <span class="function"><strong>is_dir()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">is_dir</span><span style="color: #007700">(</span><span style="color: #DD0000">'a_file.txt'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">is_dir</span><span style="color: #007700">(</span><span style="color: #DD0000">'bogus_dir/abc'</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">is_dir</span><span style="color: #007700">(</span><span style="color: #DD0000">'..'</span><span style="color: #007700">)); </span><span style="color: #FF8000">//one dir up<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(false)
bool(false)
bool(true)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.is-dir-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Upon failure, an <strong><code>E_WARNING</code></strong> is emitted.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.is-dir-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">The results of this
function are cached. See <span class="function"><a href="function.clearstatcache.html" class="function">clearstatcache()</a></span> for
more details.</span></p></blockquote>
<div class="tip"><strong class="tip">Tip</strong><p class="simpara">As of PHP 5.0.0, this function
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> to determine which wrappers support
<span class="function"><a href="function.stat.html" class="function">stat()</a></span> family of functionality.</p></div>
</div>
<div class="refsect1 seealso" id="refsect1-function.is-dir-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.chdir.html" class="function" rel="rdfs-seeAlso">chdir()</a> - Change directory</span></li>
<li class="member"> <span class="function"><a href="function.dir.html" class="function" rel="rdfs-seeAlso">dir()</a> - Return an instance of the Directory class</span></li>
<li class="member"> <span class="function"><a href="function.opendir.html" class="function" rel="rdfs-seeAlso">opendir()</a> - Open directory handle</span></li>
<li class="member"> <span class="function"><a href="function.is-file.html" class="function" rel="rdfs-seeAlso">is_file()</a> - Tells whether the filename is a regular file</span></li>
<li class="member"> <span class="function"><a href="function.is-link.html" class="function" rel="rdfs-seeAlso">is_link()</a> - Tells whether the filename is a symbolic link</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.glob.html">glob</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.is-executable.html">is_executable</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>
