WP_Filesystem_SSH2::sftp_path( string $path ): string
- Since
- 4.4.0
- Source
wp-admin/includes/class-wp-filesystem-ssh2.php:200
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.
Compatibility
- WordPress
- since 4.4.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- The File/Directory path on the remote server to return
Return value
string- The ssh2.sftp:// wrapped path to use.
Performance profile
How much work a call to WP_Filesystem_SSH2::sftp_path() 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
- Scaling
- Constant
- Instructions
- 12–13
- Plugin surface
- None
- Called by
- 14
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 13.
Nothing here hands control to plugin code.
14 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Filesystem_SSH2::sftp_path() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 12–13 | ltrim() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 13 instructions, 12–13 executed per call, 1 branch. 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.
Used by · 14
- WP_Filesystem_SSH2::atime()Gets the file's last access time.
- WP_Filesystem_SSH2::dirlist()Gets details for files in a directory or a specific file.
- WP_Filesystem_SSH2::exists()Checks if a file or directory exists.
- WP_Filesystem_SSH2::get_contents()Reads entire file into a string.
- WP_Filesystem_SSH2::get_contents_array()Reads entire file into an array.
- WP_Filesystem_SSH2::getchmod()Gets the permissions of the specified file or filepath in their octal format.
- WP_Filesystem_SSH2::group()Gets the file's group.
- WP_Filesystem_SSH2::is_dir()Checks if resource is a directory.
- WP_Filesystem_SSH2::is_file()Checks if resource is a file.
- WP_Filesystem_SSH2::is_readable()Checks if a file is readable.
- WP_Filesystem_SSH2::mtime()Gets the file modification time.
- WP_Filesystem_SSH2::owner()Gets the file owner.
Show all 14
- WP_Filesystem_SSH2::put_contents()Writes a string to a file.
- WP_Filesystem_SSH2::size()Gets the file size (in bytes).
Source code
public function sftp_path( $path ) { if ( '/' === $path ) { $path = '/./'; } return 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim( $path, '/' ); }Changelog
Introduced in 4.4.0. 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.9.7 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.