wppaste
WordPress

WP_Filesystem_SSH2::mkdir( string $path, int|false $chmod = false, string|int|false $chown = false, string|int|false $chgrp = false ): bool

Since
2.7.0
Source
wp-admin/includes/class-wp-filesystem-ssh2.php:759
Creates a directory.

Compatibility

WordPress
since 2.7.0
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

$pathstring
Path for new directory.
$chmodint|falseoptional
The permissions as octal number (or false to skip chmod).
Default false.Default: false
$chownstring|int|falseoptional
A user name or number (or false to skip chown).
Default false.Default: false
$chgrpstring|int|falseoptional
A group name or number (or false to skip chgrp).
Default false.Default: false

Return value

bool
True on success, false on failure.

Performance profile

How much work a call to WP_Filesystem_SSH2::mkdir() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
7–42

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 45.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 7 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Filesystem_SSH2::mkdir() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always7none
empty($path)13untrailingslashit()
!empty($path) && !ssh2_sftp_mkdir()23–25untrailingslashit(), ssh2_sftp_mkdir()
!empty($path) && ssh2_sftp_mkdir()32–34untrailingslashit(), ssh2_sftp_mkdir(), ssh2_sftp_chmod()
!empty($path) && ssh2_sftp_mkdir()36–38untrailingslashit(), ssh2_sftp_mkdir(), ssh2_sftp_chmod(), ->chgrp()
!empty($path) && ssh2_sftp_mkdir()36–38untrailingslashit(), ssh2_sftp_mkdir(), ssh2_sftp_chmod(), ->chown()
!empty($path) && ssh2_sftp_mkdir()40–42untrailingslashit(), ssh2_sftp_mkdir(), ssh2_sftp_chmod(), ->chown(), ->chgrp()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 45 instructions, 7–42 executed per call, 6 branches. The work does not change between versions.

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 · 3

Source code

View on Trac View on GitHub 

	public function mkdir( $path, $chmod = false, $chown = false, $chgrp = false ) {		if ( ! $this->sftp_link ) {			return false;		}		$path = untrailingslashit( $path ); 		if ( empty( $path ) ) {			return false;		} 		if ( ! $chmod ) {			$chmod = FS_CHMOD_DIR;		} 		if ( ! ssh2_sftp_mkdir( $this->sftp_link, $path, $chmod, true ) ) {			return false;		} 		// Set directory permissions.		ssh2_sftp_chmod( $this->sftp_link, $path, $chmod ); 		if ( $chown ) {			$this->chown( $path, $chown );		} 		if ( $chgrp ) {			$this->chgrp( $path, $chgrp );		} 		return true;	}

Changelog

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-wp-filesystem-ssh2.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.