WP_Filesystem_SSH2::sftp_path( string $path )

Gets the ssh2.sftp PHP stream wrapper path to open for the given file.

Description

This method also works around a PHP bug where the root directory (/) cannot be opened by PHP functions, causing a false failure. In order to work around this, the path is converted to /./ which is semantically the same as / See https://bugs.php.net/bug.php?id=64169 for more details.

Parameters

$path

(string) (Required) The File/Directory path on the remote server to return

Return

(string) The ssh2.sftp:// wrapped path to use.

Source

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

public function sftp_path( $path ) {
		if ( '/' === $path ) {
			$path = '/./';
		}

		return 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim( $path, '/' );
	}

Used By

Used By Description
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::exists()

Checks if a file or directory exists.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::is_file()

Checks if resource is a file.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::is_dir()

Checks if resource is a directory.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::is_readable()

Checks if a file is readable.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::atime()

Gets the file’s last access time.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::mtime()

Gets the file modification time.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::size()

Gets the file size (in bytes).
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::dirlist()

Gets details for files in a directory or a specific file.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::get_contents()

Reads entire file into a string.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::get_contents_array()

Reads entire file into an array.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::put_contents()

Writes a string to a file.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::owner()

Gets the file owner.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::getchmod()

Gets the permissions of the specified file or filepath in their octal format.
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::group()

Gets the file’s group.

Changelog

Version Description
4.4.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/sftp_path