Table of Contents

move

API Package Subpackage Class Method Reference Last reviewed Doc status
API Home Package Joomla.Framework Subpackage FileSystem Class JFile Method move Reference move() Never Work in Progress

Moves a file. If the current user has permission and safe mode is turned off, then this function will use the PHP rename function. Otherwise, the function will use FTP (if enabled) to move the file. The function returns true if the file was successfully moved. Otherwise, the function returns false and may raise a warning using the JError class.

Syntax

boolean move ( $src, $dest, $path )

$src string is a string containing the path to the source file.
$dest string is a string containing the path to the destination file.
$path string is an optional string containing a base path to prefix to the file names.

Examples

Example: This example moves a file.

Example

if (JFile::move( 'clock.jpg', 'clock_moved.jpg', 'images/stories/' )) {
    echo "<h3>File Successfully Moved</h3>";
} else {
    echo "<h3>Could not move file</h3>";
}