file_scan_directory

Versions
4.6 – 6: file_scan_directory($dir, $mask, $nomask = array('.', '..', 'CVS'), $callback = 0, $recurse = TRUE, $key = 'filename', $min_depth = 0, $depth = 0)
7: file_scan_directory($dir, $mask, $options = array(), $depth = 0)

Finds all files that match a given mask in a given directory.

Directories and files beginning with a period are excluded; this prevents hidden files and directories (such as SVN working directories) from being scanned.

Parameters

$dir The base directory or URI to scan, without trailing slash.

$mask The preg_match() regular expression of the files to find.

$options An associative array of additional options, with the following elements:

'nomask': The preg_match() regular expression of the files to ignore. Defaults to '/(\.\.?|CVS)$/'.
'callback': The callback function to call for each match. There is no default callback.
'recurse': When TRUE, the directory scan will recurse the entire tree starting at the provided directory. Defaults to TRUE.
'key': The key to be used for the returned associative array of files. Possible values are 'uri', for the file's URI; 'filename', for the basename of the file; and 'name' for the name of the file without the extension. Defaults to 'uri'.
'min_depth': Minimum depth of directories to return files from. Defaults to 0.

$depth Current depth of recursion. This parameter is only used internally and should not be passed in.

Return value

An associative array (keyed on the chosen key) of objects with 'uri', 'filename', and 'name' members corresponding to the matching files.

▸ 10 functions call file_scan_directory()

▾ 10 functions call file_scan_directory()

drupal_clear_css_cache in includes/common.inc: Delete all cached CSS files.
drupal_clear_js_cache in includes/common.inc: Delete all cached JS files.
drupal_detect_database_types in includes/install.inc: Detect all supported databases that are compiled into PHP.
drupal_system_listing in includes/common.inc: Return an array of system file objects.
file_scan_directory in includes/file.inc: Finds all files that match a given mask in a given directory.
locale_batch_by_component in includes/locale.inc: Prepare a batch to run when installing modules or enabling themes. This batch will import translations for the newly added components in all the languages already set up on the site.
locale_batch_by_language in includes/locale.inc: Prepare a batch to import translations for all enabled modules in a given language.
simpletest_install in modules/simpletest/simpletest.install: Implement hook_install().
simpletest_uninstall in modules/simpletest/simpletest.install: Implement hook_uninstall().
_registry_rebuild in includes/registry.inc: @see registry_rebuild.

Code

includes/file.inc, line 1603

<?php
function file_scan_directory($dir, $mask, $options = array(), $depth = 0) {
  // Merge in defaults.
  $options += array(
    'nomask' => '/(\.\.?|CVS)$/',
    'callback' => 0,
    'recurse' => TRUE,
    'key' => 'uri',
    'min_depth' => 0,
  );

  $options['key'] = in_array($options['key'], array('uri', 'filename', 'name')) ? $options['key'] : 'uri';
  $files = array();
  if (is_dir($dir) && $handle = opendir($dir)) {
    while (FALSE !== ($filename = readdir($handle))) {
      if (!preg_match($options['nomask'], $filename) && $filename[0] != '.') {
        $uri = "$dir/$filename";
        $uri = file_stream_wrapper_uri_normalize($uri);
        if (is_dir($uri) && $options['recurse']) {
          // Give priority to files in this folder by merging them in after any subdirectory files.
          $files = array_merge(file_scan_directory($uri, $mask, $options, $depth + 1), $files);
        }
        elseif ($depth >= $options['min_depth'] && preg_match($mask, $filename)) {
          // Always use this match over anything already set in $files with the
          // same $$options['key'].
          $file = new StdClass;
          $file->uri = $uri;
          $file->filename = $filename;
          $file->name = pathinfo($filename, PATHINFO_FILENAME);
          $key = $options['key'];
          $files[$file->$key] = $file;
          if ($options['callback']) {
            $options['callback']($uri);
          }
        }
      }
    }

    closedir($handle);
  }

  return $files;
}
?>