php-doc-en/reference/filesystem/functions/mkdir.xml
Jakub Vrana 6e83b49413 Context parameter (bug #32499)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183271 c90b9560-bf6c-de11-be94-00142212c4b1
2005-03-31 15:01:44 +00:00

91 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.17 $ -->
<!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.39 -->
<refentry id="function.mkdir">
<refnamediv>
<refname>mkdir</refname>
<refpurpose>Makes directory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>mkdir</methodname>
<methodparam><type>string</type><parameter>pathname</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>recursive</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
</methodsynopsis>
<para>
Attempts to create the directory specified by pathname.
</para>
<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>
<para>
<note>
<para>
Mode is ignored on Windows, and became optional in PHP 4.2.0.
</para>
</note>
</para>
<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.
<example>
<title><function>mkdir</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
mkdir("/path/to/my/dir", 0700);
?>
]]>
</programlisting>
</example>
</para>
<para>
&return.success;
</para>
<note>
<simpara>
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>.
</simpara>
</note>
&note.context-support;
<note>
<simpara>
The <parameter>recursive</parameter> parameter was added as of PHP 5.0.0.
</simpara>
</note>
&note.sm.uidcheck.dir;
<para>
See also <function>rmdir</function>.
</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:"../../../../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
-->