mkdir
(PHP 4, PHP 5, PHP 7, PHP 8)
mkdir — Makes directory
Description
mkdir( string $directory, int $permissions = 0777, bool $recursive = false, ?resource $context = null ): bool
Attempts to create the directory specified by directory
.
Parameters
-
directory
-
The directory path.
-
permissions
-
The permissions are 0777 by default, which means the widest possible access. For more information on permissions, read the details on the chmod() page.
Note:
permissions
is ignored on Windows.Note that you probably want to specify the
permissions
as an octal number, which means it should have a leading zero. Thepermissions
is also modified by the current umask, which you can change using umask(). -
recursive
-
Allows the creation of nested directories specified in the
directory
. -
context
-
A context stream resource.
Return Values
Returns true
on success or false
on failure.
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.
Examples
Example #1 mkdir() example
<?php mkdir("/path/to/my/dir", 0700); ?>
Example #2 mkdir() using the recursive
parameter
<?php // Desired directory 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 directories...'); } // ... ?>
© 1997–2021 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.mkdir.php