array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.ssh2-sftp-rename.php', 1 => 'ssh2_sftp_rename', 2 => 'Rename a remote file', ), 'up' => array ( 0 => 'ref.ssh2.php', 1 => 'SSH2 Functions', ), 'prev' => array ( 0 => 'function.ssh2-sftp-realpath.php', 1 => 'ssh2_sftp_realpath', ), 'next' => array ( 0 => 'function.ssh2-sftp-rmdir.php', 1 => 'ssh2_sftp_rmdir', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/ssh2/functions/ssh2-sftp-rename.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ssh2_sftp_rename

(PECL ssh2 >= 0.9.0)

ssh2_sftp_rename — Rename a remote file

Description

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

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