function file_download in Drupal 7

Same name and namespace in other branches

1. 4 includes/file.inc \file_download()
2. 5 includes/file.inc \file_download()
3. 6 includes/file.inc \file_download()

Menu handler for private file transfers.

Call modules that implement hook_file_download() to find out if a file is accessible and what headers it should be transferred with. If one or more modules returned headers the download will start with the returned headers. If a module returns -1 drupal_access_denied() will be returned. If the file exists but no modules responded drupal_access_denied() will be returned. If the file does not exist drupal_not_found() will be returned.

See also

system_menu()

Related topics

1 call to file_download()

image_style_deliver in modules/image/image.module

Page callback: Generates a derivative, given a style and image path.

1 string reference to 'file_download'

system_menu in modules/system/system.module

Implements hook_menu().

File

includes/file.inc, line 2066

API for handling file uploads and server file management.

Code

function file_download() {

  // Merge remainder of arguments from GET['q'], into relative file path.
  $args = func_get_args();
  $scheme = array_shift($args);
  $target = implode('/', $args);
  $uri = $scheme . '://' . $target;
  if (file_stream_wrapper_valid_scheme($scheme) && file_exists($uri)) {
    $headers = file_download_headers($uri);
    if (count($headers)) {
      file_transfer($uri, $headers);
    }
    drupal_access_denied();
  }
  else {
    drupal_not_found();
  }
  drupal_exit();
}