FTP_RENAME(3) 1 FTP_RENAME(3)
ftp_rename - Renames a file or a directory on the FTP server
SYNOPSIS
bool ftp_rename (resource $ftp_stream, string $oldname, string $newname)
DESCRIPTION
ftp_rename(3) renames a file or a directory on the FTP server.
PARAMETERS
o $ftp_stream
- The link identifier of the FTP connection.
o $oldname
- The old file/directory name.
o $newname
- The new name.
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
ftp_rename(3) example
<?php
$old_file = 'somefile.txt.bak';
$new_file = 'somefile.txt';
// set up basic connection
$conn_id = ftp_connect($ftp_server);
// login with username and password
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
// try to rename $old_file to $new_file
if (ftp_rename($conn_id, $old_file, $new_file)) {
echo "successfully renamed $old_file to $new_file
";
} else {
echo "There was a problem while renaming $old_file to $new_file
";
}
// close the connection
ftp_close($conn_id);
?>
PHP Documentation Group FTP_RENAME(3)
