function file_download_access

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

file_download_headers()

hook_file_download()

Related topics

1 call to file_download_access()
file_managed_file_value in modules/file/file.module
The #value_callback for a managed_file type element.

File

includes/file.inc, line 2158

Code

function file_download_access($uri) {
    return count(file_download_headers($uri)) > 0;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.