php-doc-en/reference/filesystem/functions/mkdir.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mkdir">
 <refnamediv>
  <refname>mkdir</refname>
  <refpurpose>Makes directory</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>mkdir</methodname>
   <methodparam><type>string</type><parameter>pathname</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0777</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>recursive</parameter><initializer>false</initializer></methodparam>
   <methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
  </methodsynopsis>
  <para>
   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.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>pathname</parameter></term>
     <listitem>
      <para>
       The directory path.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       The mode is 0777 by default, which means the widest possible
       access. For more information on modes, read the details
       on the <function>chmod</function> page.
      </para>
      <note>
       <para>
        <parameter>mode</parameter> is ignored on Windows.
       </para>
      </note>
      <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
       <function>umask</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>recursive</parameter></term>
     <listitem>
      <para>
       Allows the creation of nested directories specified in the 
       <parameter>pathname</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      &note.context-support;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.0.0</entry>
       <entry>
        The <parameter>recursive</parameter> parameter was added
       </entry>
      </row>
      <row>
       <entry>5.0.0</entry>
       <entry>
        As of PHP 5.0.0 <function>mkdir</function> can also be used with
        <emphasis>some</emphasis> URL wrappers.  Refer to <xref
        linkend="wrappers"/> for a listing of which wrappers support
        <function>mkdir</function>
       </entry>
      </row>
      <row>
       <entry>4.2.0</entry>
       <entry>
        The <parameter>mode</parameter> parameter became optional.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mkdir</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
mkdir("/path/to/my/dir", 0700);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title><function>mkdir</function> using the <parameter>recursive</parameter> parameter</title>
    <programlisting role="php">
<![CDATA[
<?php
// Desired folder structure
$structure = './depth1/depth2/depth3/';

// To create the nested structure, the $recursive parameter 
// to mkdir() must be specified.

if (!mkdir($structure, 0, true)) {
    die('Failed to create folders...');
}

// ...
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.sm.uidcheck.dir;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_dir</function></member>    
    <member><function>rmdir</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->