Home › API reference › file.inc

file_usage_list

  1. drupal
    1. 7
Versions
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, the third has 'id' and 'count' keys.

See also

file_usage_add()

file_usage_delete()

Related topics

File interface
Common file handling functions.

▸ 4 functions call file_usage_list()

▾ 4 functions call file_usage_list()

file_delete in drupal/includes/file.inc
Delete a file and its database record.
file_field_delete_file in drupal/modules/file/file.field.inc
Decrements a file usage count and attempts to delete it.
file_managed_file_validate in drupal/modules/file/file.module
An #element_validate callback for the managed_file element.
system_cron in drupal/modules/system/system.module
Implements hook_cron().

Code

drupal/includes/file.inc, line 614

<?php
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] = array(
      'id' => $usage->id,
      'count' => $usage->count,
    );
  }
  return $references;
}
?>