MKDIR(3) 1 MKDIR(3)
mkdir - Makes directory
SYNOPSIS
bool mkdir (string $pathname, [int $mode = 0777], [bool $recursive = false], [resource $context])
DESCRIPTION
Attempts to create the directory specified by pathname.
PARAMETERS
o $pathname
- The directory path.
o $mode
- The mode is 0777 by default, which means the widest possible access. For more information on modes, read the details on the
chmod(3) page.
Note
$mode is ignored on Windows.
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 umask(3).
o $recursive
- Allows the creation of nested directories specified in the $pathname.
o $context
-
Note
Context support was added with PHP 5.0.0. For a description of contexts, refer to "Streams".
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
mkdir(3) example
<?php
mkdir("/path/to/my/dir", 0700);
?>
Example #2
mkdir(3) using the $recursive parameter
<?php
// Desired folder structure
$structure = './depth1/depth2/depth3/';
// To create the nested structure, the $recursive parameter
// to mkdir() must be specified.
if (!mkdir($structure, 0777, true)) {
die('Failed to create folders...');
}
// ...
?>
ERRORS
/EXCEPTIONS
Emits an E_WARNING level error if the directory already exists.
Emits an E_WARNING level error if the relevant permissions prevent creating the directory.
NOTES
Note
When safe mode 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.
SEE ALSO
is_dir(3), rmdir(3).
PHP Documentation Group MKDIR(3)
