file_save_upload

Versions
4.6: file_save_upload($source, $dest = 0, $replace = FILE_EXISTS_RENAME)
4.7: file_save_upload($source, $dest = false, $replace = FILE_EXISTS_RENAME)
5: file_save_upload($source, $dest = FALSE, $replace = FILE_EXISTS_RENAME)
6: file_save_upload($source, $validators = array(), $dest = FALSE, $replace = FILE_EXISTS_RENAME)
7: file_save_upload($source, $validators = array(), $destination = FALSE, $replace = FILE_EXISTS_RENAME)

Saves a file upload to a new location. The source file is validated as a proper upload and handled as such.

Parameters

$source A string specifying the name of the upload field to save. This parameter will contain the resulting destination filename in case of success.

$dest A string containing the directory $source should be copied to, will use the temporary directory in case no other value is set.

$replace A boolean, set to true if the destination should be replaced when in use, but when false append a _X to the filename.

Return value

An object containing file info or 0 in case of error.

▸ 6 functions call file_save_upload()

▾ 6 functions call file_save_upload()

fileupload_execute in developer/examples/fileupload.module: Implementation of hook_execute().
hook_prepare in developer/hooks/node.php: This is a hook used by node modules. It is called after load but before the node is shown on the add/edit form.
hook_submit in developer/hooks/node.php: This is a hook used by node modules. It is called after validation has succeeded and before insert/update. It is used to for actions which must happen only if the node is to be saved. Usually, $node is changed in some way and then the actual saving of...
system_theme_settings in modules/system.module: Menu callback; display theme configuration for entire site and individual themes.
upload_save in modules/upload.module
user_validate_picture in modules/user.module

Code

includes/file.inc, line 484

<?php
function file_save_upload($source, $dest = false, $replace = FILE_EXISTS_RENAME) {
  // Make sure $source exists && is valid.
  if ($file = file_check_upload($source)) {

    // This should be refactored, file_check_upload has already
    // moved the file to the temporary folder.
    if (!$dest) {
      $dest = file_directory_temp();
      $temporary = 1;
      if (is_file($file->filepath)) {
        // If this file was uploaded by this user before replace the temporary copy.
        $replace = FILE_EXISTS_REPLACE;
      }
    }

    unset($_SESSION['file_uploads'][is_object($source) ? $source->source : $source]);
    if (file_move($file, $dest, $replace)) {
      if ($temporary) {
        $_SESSION['file_uploads'][is_object($source) ? $source->source : $source] = $file;
      }
      return $file;
    }
    return 0;
  }
  return 0;
}
?>