<!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>Makes directory</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.lstat.html">lstat</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.move-uploaded-file.html">move_uploaded_file</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.mkdir" class="refentry">
<div class="refnamediv">
<h1 class="refname">mkdir</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">mkdir</span> — <span class="dc-title">Makes directory</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mkdir-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>mkdir</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$pathname</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code><span class="initializer"> = 0777</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$recursive</code><span class="initializer"> = false</span></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code></span>
]]] )</div>
<p class="para rdfs-comment">
Attempts to create the directory specified by pathname. The directory must not already exist, and the relevant permissions must permit this. An E_WARNING level error will be generated on failure.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mkdir-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">pathname</code></em></span>
<dd>
<p class="para">
The directory path.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
The mode is 0777 by default, which means the widest possible
access. For more information on modes, read the details
on the <span class="function"><a href="function.chmod.html" class="function">chmod()</a></span> page.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
<em><code class="parameter">mode</code></em> is ignored on Windows.
</p>
</p></blockquote>
<p class="para">
Note that you probably want to specify the mode as an octal number,
which means it should have a leading zero. The mode is also modified
by the current umask, which you can change using
<span class="function"><a href="function.umask.html" class="function">umask()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">recursive</code></em></span>
<dd>
<p class="para">
Allows the creation of nested directories specified in the
<em><code class="parameter">pathname</code></em>.
</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.mkdir-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.mkdir-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>
The <em><code class="parameter">recursive</code></em> parameter was added
</td>
</tr>
<tr>
<td>5.0.0</td>
<td>
As of PHP 5.0.0 <span class="function"><strong>mkdir()</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>mkdir()</strong></span>
</td>
</tr>
<tr>
<td>4.2.0</td>
<td>
The <em><code class="parameter">mode</code></em> parameter became optional.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mkdir-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2411">
<p><strong>Example #1 <span class="function"><strong>mkdir()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />mkdir</span><span style="color: #007700">(</span><span style="color: #DD0000">"/path/to/my/dir"</span><span style="color: #007700">, </span><span style="color: #0000BB">0700</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-2412">
<p><strong>Example #2 <span class="function"><strong>mkdir()</strong></span> using the <em><code class="parameter">recursive</code></em> parameter</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Desired folder structure<br /></span><span style="color: #0000BB">$structure </span><span style="color: #007700">= </span><span style="color: #DD0000">'./depth1/depth2/depth3/'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// To create the nested structure, the $recursive parameter <br />// to mkdir() must be specified.<br /><br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">mkdir</span><span style="color: #007700">(</span><span style="color: #0000BB">$structure</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">)) {<br /> die(</span><span style="color: #DD0000">'Failed to create folders...'</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">// ...<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.mkdir-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.mkdir-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.rmdir.html" class="function" rel="rdfs-seeAlso">rmdir()</a> - Removes directory</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.lstat.html">lstat</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.move-uploaded-file.html">move_uploaded_file</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>
