file_download_access
function file_download_access
file_download_access($uri)
Checks that the current user has access to a particular file.
The return value of this function hinges on the return value from file_download_headers(), which is the function responsible for collecting access information through hook_file_download().
If immediately transferring the file to the browser and the headers will need to be retrieved, the return value of file_download_headers() should be used to determine access directly, so that access checks will not be run twice.
Parameters
$uri: The URI for the file whose access should be retrieved.
Return value
Boolean TRUE if access is allowed. FALSE if access is not allowed.
See also
Related topics
File
- includes/file.inc, line 2069
- API for handling file uploads and server file management.
Code
function file_download_access($uri) { return count(file_download_headers($uri)) > 0; }
© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/includes!file.inc/function/file_download_access/7.x