function hook_library

You are here

7 system.api.php hook_library()

Registers JavaScript/CSS libraries associated with a module.

Modules implementing this return an array of arrays. The key to each sub-array is the machine readable name of the library. Each library may contain the following items:

  • 'title': The human readable name of the library.
  • 'website': The URL of the library's web site.
  • 'version': A string specifying the version of the library; intentionally not a float because a version like "1.2.3" is not a valid float. Use PHP's version_compare() to compare different versions.
  • 'js': An array of JavaScript elements; each element's key is used as $data argument, each element's value is used as $options array for drupal_add_js(). To add library-specific (not module-specific) JavaScript settings, the key may be skipped, the value must specify 'type' => 'setting', and the actual settings must be contained in a 'data' element of the value.
  • 'css': Like 'js', an array of CSS elements passed to drupal_add_css().
  • 'dependencies': An array of libraries that are required for a library. Each element is an array listing the module and name of another library. Note that all dependencies for each dependent library will also be added when this library is added.

Registered information for a library should contain re-usable data only. Module- or implementation-specific data and integration logic should be added separately.

Return value

An array defining libraries associated with a module.

See also

system_library()

drupal_add_library()

drupal_get_library()

Related topics

7 functions implement hook_library()

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

common_test_library in modules/simpletest/tests/common_test.module
Implements hook_library().
contextual_library in modules/contextual/contextual.module
Implements hook_library().
drupal_add_library in includes/common.inc
Adds multiple JavaScript or CSS files at the same time.
drupal_get_library in includes/common.inc
Retrieves information for a JavaScript/CSS library.
JS_LIBRARY in includes/common.inc
The default group for JavaScript and jQuery libraries added to the page.

... See full list

1 invocation of hook_library()
drupal_get_library in includes/common.inc
Retrieves information for a JavaScript/CSS library.

File

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

Code

function hook_library() {
  // Library One.
  $libraries['library-1'] = array(
    'title' => 'Library One',
    'website' => 'http://example.com/library-1',
    'version' => '1.2',
    'js' => array(
      drupal_get_path('module', 'my_module') . '/library-1.js' => array(),
    ),
    'css' => array(
      drupal_get_path('module', 'my_module') . '/library-2.css' => array(
        'type' => 'file',
        'media' => 'screen',
      ),
    ),
  );
  // Library Two.
  $libraries['library-2'] = array(
    'title' => 'Library Two',
    'website' => 'http://example.com/library-2',
    'version' => '3.1-beta1',
    'js' => array(
      
      // JavaScript settings may use the 'data' key.
      array(
        'type' => 'setting',
        'data' => array('library2' => TRUE),
      ),
    ),
    'dependencies' => array(
      
      // Require jQuery UI core by System module.
      array('system', 'ui'),
      
      // Require our other library.
      array('my_module', 'library-1'),
      
      // Require another library.
      array('other_module', 'library-3'),
    ),
  );
  return $libraries;
}

Comments

Something to watch out for. It turns out when you implement hook_library in your module the libraries are not automatically made available to the module. You have to add the library using drupal_add_library('your_module_name', 'name_of_library_you_want_to_load') ; Hope this helps someone.

The reason for this is to avoid loading it when not necessary.

If you're looking for a way to include libraries that are not bundled with a module (eg: a jQuery plug-in), see the Libraries API.

If you're trying to add a weight to a library, don't do it at the library level. You have to specify it at the CSS and JS level, for each CSS/JS file. See the docs for drupal_add_css() and drupal_add_js() for details.

In Drupal 8, this is now called hook_library_info().

It was finally removed: see https://drupal.org/node/2201089

Be careful when using the short hand syntax for js files - see http://drupal.org/node/1396892

this seems really useful, but i'm a bit confused :-)

I see reference to creating .info files for the libraries you want to use eg https://drupal.org/node/1342220#libraries-meta

how does this hook differ from this?

and wouldn't the .info file be preferable? (as it is once per library rather than for each client module)?

This is confusing because the name "Libraries" is being used for two different things here.

This page, about hook_library(), is only about the core functionality included in Drupal 7.

The page you linked to is a community doc about the Libraries API module. This contrib module adds some additional functionality, but unless you download and install that module, any .info files you create will be ignored.

sorry basic questions:

* when (ie for what reason) do you implement this hook?

* when is it called?

* does it then load these files on every page?