# ssh2_sftp_rename

(PECL ssh2 >= 0.9.0)

ssh2_sftp_rename — Rename a remote file

### 说明

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

Renames a file on the remote filesystem.

### 参数

`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`.

### 返回值

成功时返回 `TRUE`， 或者在失败时返回 `FALSE`。

### 范例

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');
    ?>

### 参见

- rename() - 重命名一个文件或目录