wp_mkdir_p( string $target ): bool
- Since
- 2.0.1
- Source
wp-includes/functions.php:2042
Recursive directory creation based on full path.
Description
Will attempt to set permissions on folders.
Compatibility
- WordPress
- since 2.0.1
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$targetstring- Full path to attempt to create.
Return value
bool- Whether the path was created. True if path already exists.
Performance profile
How much work a call to wp_mkdir_p() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Scales with input
- Instructions
- 25–88
- Plugin surface
- None
- Called by
- 7
Reads or writes the filesystem via file_exists().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 112.
Nothing here hands control to plugin code.
7 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- filesystemfilesystem access
file_exists()called directly
What one call costs · 16 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_mkdir_p() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!wp_is_stream() && !file_exists() && $target | 25–31 | wp_is_stream(), rtrim(), file_exists() |
!wp_is_stream() && file_exists() | 28–32 | wp_is_stream(), rtrim(), file_exists(), is_dir() |
wp_is_stream() && !file_exists() && $target | 34–40 | wp_is_stream(), explode(), rtrim(), file_exists() |
wp_is_stream() && file_exists() | 37–41 | wp_is_stream(), explode(), rtrim(), file_exists(), is_dir() |
!wp_is_stream() && !file_exists() && !$target && $target_parent === "." && !mkdir() | 47–53 | wp_is_stream(), rtrim(), file_exists(), stat(), mkdir() |
!wp_is_stream() && !file_exists() && !$target && $target_parent !== "." && !mkdir() | 51–60 | wp_is_stream(), rtrim(), file_exists(), is_dir(), stat(), mkdir() |
!wp_is_stream() && !file_exists() && !$target && $target_parent === "." && mkdir() && $dir_perms === false | 53–59 | wp_is_stream(), rtrim(), file_exists(), stat(), mkdir(), umask() |
wp_is_stream() && !file_exists() && !$target && $target_parent === "." && !mkdir() | 56–62 | wp_is_stream(), explode(), rtrim(), file_exists(), stat(), mkdir() |
!wp_is_stream() && !file_exists() && !$target && $target_parent !== "." && mkdir() && $dir_perms === false | 57–66 | wp_is_stream(), rtrim(), file_exists(), is_dir(), stat(), mkdir(), umask() |
wp_is_stream() && !file_exists() && !$target && $target_parent !== "." && !mkdir() | 60–69 | wp_is_stream(), explode(), rtrim(), file_exists(), is_dir(), stat(), mkdir() |
wp_is_stream() && !file_exists() && !$target && $target_parent === "." && mkdir() && $dir_perms === false | 62–68 | wp_is_stream(), explode(), rtrim(), file_exists(), stat(), mkdir(), umask() |
!wp_is_stream() && !file_exists() && !$target && $target_parent === "." && mkdir() && $dir_perms !== false && !$i | 66–72 | wp_is_stream(), rtrim(), file_exists(), stat(), mkdir(), umask(), explode() |
4 further outcomes, up to 88 instructions
wp_is_stream() && !file_exists() && !$target && $target_parent !== "." && mkdir() && $dir_perms === false | 66–75 | wp_is_stream(), explode(), rtrim(), file_exists(), is_dir(), stat(), mkdir(), umask() |
!wp_is_stream() && !file_exists() && !$target && $target_parent !== "." && mkdir() && $dir_perms !== false && !$i | 70–79 | wp_is_stream(), rtrim(), file_exists(), is_dir(), stat(), mkdir(), umask(), explode() |
wp_is_stream() && !file_exists() && !$target && $target_parent === "." && mkdir() && $dir_perms !== false && !$i | 75–81 | wp_is_stream(), explode(), rtrim(), file_exists(), stat(), mkdir(), umask(), explode() |
wp_is_stream() && !file_exists() && !$target && $target_parent !== "." && mkdir() && $dir_perms !== false && !$i | 79–88 | wp_is_stream(), explode(), rtrim(), file_exists(), is_dir(), stat(), mkdir(), umask(), explode() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 112 | 25–88 | 13 | |
| 8.5 | 112 | 25–88 | 13 | |
| 8.4 | 112 | 25–88 | 13 | 22 fewer instructions than PHP 8.3 |
| 8.3 | 134 | 31–105 | 13 | |
| 8.2 | 134 | 31–105 | 13 | |
| 8.1 | 134 | 31–105 | 13 | |
| 7.4 | 134 | 31–105 | 13 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- wp_is_stream()Tests if a given path is a stream URL
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
Used by · 7
- WP_Image_Editor::make_image()Either calls editor's save function or handles file as a stream.
- WP_Image_Editor_Imagick::write_image()Writes an image to a file or stream.
- _copy_image_file()Copies an existing image file.
- wp_crop_image()Crops an image to a given size.
- wp_privacy_generate_personal_data_export_file()Generate the personal data export file.
- wp_upload_bits()Creates a file in the upload folder with given content.
- wp_upload_dir()Returns an array containing the current upload directory's path and URL.
Source code
function wp_mkdir_p( $target ) { $wrapper = null; // Strip the protocol. if ( wp_is_stream( $target ) ) { list( $wrapper, $target ) = explode( '://', $target, 2 ); } // From php.net/mkdir user contributed notes. $target = str_replace( '//', '/', $target ); // Put the wrapper back on the target. if ( null !== $wrapper ) { $target = $wrapper . '://' . $target; } /* * Safe mode fails with a trailing slash under certain PHP versions. * Use rtrim() instead of untrailingslashit to avoid formatting.php dependency. */ $target = rtrim( $target, '/' ); if ( empty( $target ) ) { $target = '/'; } if ( file_exists( $target ) ) { return @is_dir( $target ); } // Do not allow path traversals. if ( str_contains( $target, '../' ) || str_contains( $target, '..' . DIRECTORY_SEPARATOR ) ) { return false; } // We need to find the permissions of the parent folder that exists and inherit that. $target_parent = dirname( $target ); while ( '.' !== $target_parent && ! is_dir( $target_parent ) && dirname( $target_parent ) !== $target_parent ) { $target_parent = dirname( $target_parent ); } // Get the permission bits. $stat = @stat( $target_parent ); if ( $stat ) { $dir_perms = $stat['mode'] & 0007777; } else { $dir_perms = 0777; } if ( @mkdir( $target, $dir_perms, true ) ) { /* * If a umask is set that modifies $dir_perms, we'll have to re-set * the $dir_perms correctly with chmod() */ if ( ( $dir_perms & ~umask() ) !== $dir_perms ) { $folder_parts = explode( '/', substr( $target, strlen( $target_parent ) + 1 ) ); for ( $i = 1, $c = count( $folder_parts ); $i <= $c; $i++ ) { chmod( $target_parent . '/' . implode( '/', array_slice( $folder_parts, 0, $i ) ), $dir_perms ); } } return true; } return false;}Changelog
Introduced in 2.0.1. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.