function file_usage_list

Determines where a file is used.

Parameters

$file: A file entity.

Return value

A nested array with usage data. The first level is keyed by module name,: the second by object type and the third by the object id. The value of the third level contains the usage count.

See also

file_usage_add()

file_usage_delete()

Related topics

File

core/includes/file.inc, line 659

API for handling file uploads and server file management.

Code

function file_usage_list(File $file) {
  $result = db_select('file_usage', 'f')
    ->fields('f', array('module', 'type', 'id', 'count'))
    ->condition('fid', $file->fid)
    ->condition('count', 0, '>')
    ->execute();
  $references = array();
  foreach ($result as $usage) {
    $references[$usage->module][$usage->type][$usage->id] = $usage->count;
  }
  return $references;
}