SSH2_SFTP_RENAME(3) 1 SSH2_SFTP_RENAME(3)
ssh2_sftp_rename - Rename a remote file
SYNOPSIS
bool ssh2_sftp_rename (resource $sftp, string $from, string $to)
DESCRIPTION
Renames a file on the remote filesystem.
PARAMETERS
o $sftp
- An SSH2 SFTP resource opened by ssh2_sftp(3).
o $from
- The current file that is being renamed.
o $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(3).
PHP Documentation Group SSH2_SFTP_RENAME(3)
