streamWrapper::mkdir
(PHP 5, PHP 7, PHP 8)
streamWrapper::mkdir — Create a directory
Description
$path
, int $mode
, int $options
): boolThis method is called in response to mkdir().
Note:
In order for the appropriate error message to be returned this method should not be defined if the wrapper does not support creating directories.
Parameters
-
path
-
Directory which should be created.
-
mode
-
The value passed to mkdir().
-
options
-
A bitwise mask of values, such as
STREAM_MKDIR_RECURSIVE
.
Return Values
Returns true
on success or false
on failure.
Errors/Exceptions
Emits
E_WARNING
if call to this method fails
(i.e. not implemented).
Notes
Note:
The streamWrapper::$context property is updated if a valid context is passed to the caller function.