function file_destination

7.x file.inc file_destination($destination, $replace)
6.x file.inc file_destination($destination, $replace)
8.x file.inc file_destination($destination, $replace)

Determines the destination path for a file.

Parameters

$destination: A string specifying the desired final URI or filepath.

$replace: Replace behavior when the destination file already exists.

Return value

The destination filepath, or FALSE if the file already exists and FILE_EXISTS_ERROR is specified.

Related topics

3 calls to file_destination()
FileDirectoryTest::testFileDestination in drupal/modules/simpletest/tests/file.test
This will test the filepath for a destination based on passed flags and whether or not the file exists.
file_save_upload in drupal/includes/file.inc
Saves a file upload to a new location.
file_unmanaged_copy in drupal/includes/file.inc
Copies a file to a new location without invoking the file API.

File

drupal/includes/file.inc, line 985
API for handling file uploads and server file management.

Code

function file_destination($destination, $replace) {
  if (file_exists($destination)) {
    switch ($replace) {
      case FILE_EXISTS_REPLACE:
        // Do nothing here, we want to overwrite the existing file.
        break;

      case FILE_EXISTS_RENAME:
        $basename = drupal_basename($destination);
        $directory = drupal_dirname($destination);
        $destination = file_create_filename($basename, $directory);
        break;

      case FILE_EXISTS_ERROR:
        // Error reporting handled by calling function.
        return FALSE;
    }
  }
  return $destination;
}