ssh2_sftp_rename
PHP function
Edit on GitHub ✎
(PECL ssh2 >= 0.9.0)
Rename a remote file
Description
ssh2_sftp_rename(resource $sftp, string $from, string $to): bool
Renames a file on the remote filesystem.
Parameters
sftpAn SSH2 SFTP resource opened by
ssh2_sftp().fromThe current file that is being renamed.
toThe new file name that replaces
from.
Return Values
Success
Examples
Renaming a file via sftp
php
<?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');
?>