PHP 7.2.0 Release Candidate 2 Released

ssh2_sftp_rename

(PECL ssh2 >= 0.9.0)

ssh2_sftp_renameRename a remote file

Description

bool ssh2_sftp_rename ( resource $sftp , string $from , string $to )

Renames a file on the remote filesystem.

Parameters

sftp

An SSH2 SFTP resource opened by ssh2_sftp().

from

The current file that is being renamed.

to

The new file name that replaces from.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example #1 Renaming a file via sftp

<?php
$connection 
ssh2_connect('shell.example.com'22);
ssh2_auth_password($connection'username''password');
$sftp ssh2_sftp($connection);

ssh2_sftp_rename($sftp'/home/username/oldname''/home/username/newname');
?>

See Also

  • rename() - Renames a file or directory

add a note add a note

User Contributed Notes 2 notes

up
2
thomas dot hebinck at digionline dot de
5 years ago
An already existing file will NOT be overwritten.

http://www.openssh.com/txt/draft-ietf-secsh-filexfer-02.txt

"It is an error if there already exists a file with the name specified by newpath."
up
1
Andr Ribas
5 months ago
For some unknown reason we weren't able to rename the remote file using sftp_rename function. Instead we've used the following code:

<?php
    $connection
= ssh2_connect('localhost', 22);
   
ssh2_auth_password($connection, 'username', 'password');
   
$sftp = ssh2_sftp($connection);

   
$fromSftpUrl = "ssh2.sftp://{$sftp}/{$path_from}";
   
$toSftpUrl = "ssh2.sftp://{$sftp}/{$path_to}";

   
$success = rename($fromSftpUrl, $toSftpUrl);
?>
To Top