WP_Filesystem_SSH2::mkdir() WordPress Method

The WP_Filesystem_SSH2::mkdir() function is used to create a new directory on a remote server. The function takes two parameters: the path of the new directory and the permissions for the new directory.

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

Creates a directory.


Parameters

$path

(string)(Required)Path for new directory.

$chmod

(int|false)(Optional) The permissions as octal number (or false to skip chmod).

Default value: false

$chown

(string|int|false)(Optional) A user name or number (or false to skip chown).

Default value: false

$chgrp

(string|int|false)(Optional) A group name or number (or false to skip chgrp).

Default value: false


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

Source

File: wp-admin/includes/class-wp-filesystem-ssh2.php

	public function mkdir( $path, $chmod = false, $chown = false, $chgrp = 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;
	}


Top ↑

Changelog

Changelog
VersionDescription
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.