file_usage_list

  1. drupal
    1. 7 file.inc function
Drupal 7 file_usage_list(stdClass $file)

Determines where a file is used.

Parameters

$file: A file object.

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 interface
Common file handling functions.

7 calls to file_usage_list()

File

includes/file.inc, line 611
API for handling file uploads and server file management.

Code

function file_usage_list(stdClass $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;
}