function hook_archiver_info

7.x system.api.php hook_archiver_info()

Declare archivers to the system.

An archiver is a class that is able to package and unpackage one or more files into a single possibly compressed file. Common examples of such files are zip files and tar.gz files. All archiver classes must implement ArchiverInterface.

Each entry should be keyed on a unique value, and specify three additional keys:

  • class: The name of the PHP class for this archiver.
  • extensions: An array of file extensions that this archiver supports.
  • weight: This optional key specifies the weight of this archiver. When mapping file extensions to archivers, the first archiver by weight found that supports the requested extension will be used.

See also

hook_archiver_info_alter()

Related topics

2 functions implement hook_archiver_info()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

system_archiver_info in drupal/modules/system/system.module
Implements hook_archiver_info().
update_test_archiver_info in drupal/modules/update/tests/update_test.module
Implements hook_archiver_info().
1 invocation of hook_archiver_info()
archiver_get_info in drupal/includes/common.inc
Retrieves a list of all available archivers.

File

drupal/modules/system/system.api.php, line 4045
Hooks provided by Drupal core and the System module.

Code

function hook_archiver_info() {
  return array(
    'tar' => array(
      'class' => 'ArchiverTar',
      'extensions' => array('tar', 'tar.gz', 'tar.bz2'),
    ),
  );
}