WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Filesystem_SSH2::sftp_path()

WP_Filesystem_SSH2::sftp_path( string $path ): string

In this article

Back to top

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

$pathstringrequired
The File/Directory path on the remote server to return

Return

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

Source

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

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

View all references View on Trac View on GitHub

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

Checks if a file or directory exists.

WP_Filesystem_SSH2::is_file()wp-admin/includes/class-wp-filesystem-ssh2.php

Checks if resource is a file.

WP_Filesystem_SSH2::is_dir()wp-admin/includes/class-wp-filesystem-ssh2.php

Checks if resource is a directory.

WP_Filesystem_SSH2::is_readable()wp-admin/includes/class-wp-filesystem-ssh2.php

Checks if a file is readable.

WP_Filesystem_SSH2::atime()wp-admin/includes/class-wp-filesystem-ssh2.php

Gets the file’s last access time.

WP_Filesystem_SSH2::mtime()wp-admin/includes/class-wp-filesystem-ssh2.php

Gets the file modification time.

WP_Filesystem_SSH2::size()wp-admin/includes/class-wp-filesystem-ssh2.php

Gets the file size (in bytes).

WP_Filesystem_SSH2::dirlist()wp-admin/includes/class-wp-filesystem-ssh2.php

Gets details for files in a directory or a specific file.

WP_Filesystem_SSH2::get_contents()wp-admin/includes/class-wp-filesystem-ssh2.php

Reads entire file into a string.

WP_Filesystem_SSH2::get_contents_array()wp-admin/includes/class-wp-filesystem-ssh2.php

Reads entire file into an array.

WP_Filesystem_SSH2::put_contents()wp-admin/includes/class-wp-filesystem-ssh2.php

Writes a string to a file.

WP_Filesystem_SSH2::owner()wp-admin/includes/class-wp-filesystem-ssh2.php

Gets the file owner.

WP_Filesystem_SSH2::getchmod()wp-admin/includes/class-wp-filesystem-ssh2.php

Gets the permissions of the specified file or filepath in their octal format.

WP_Filesystem_SSH2::group()wp-admin/includes/class-wp-filesystem-ssh2.php

Gets the file’s group.

Show 9 moreShow less

Changelog

VersionDescription
4.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.