drupal_add_library

Versions

7

drupal_add_library($module, $name)

Adds multiple JavaScript or CSS files at the same time.

A library defines a set of JavaScript and/or CSS files, optionally using settings, and optionally requiring another library. For example, a library can be a jQuery plugin, a JavaScript framework, or a CSS framework. This function allows modules to load a library defined/shipped by itself or a depending module; without having to add all files of the library separately. Each library is only loaded once.

See also

drupal_get_library()

@see hook_library()

See also

hook_library_alter()

Parameters

$module The name of the module that registered the library.

$name The name of the library to add.

Return value

TRUE when the library was successfully added or FALSE if the library or one of its dependencies could not be added.

Code

includes/common.inc, line 4119

<?php
function drupal_add_library($module, $name) {
  $added = &drupal_static(__FUNCTION__, array());

  // Only process the library if it exists and it was not added already.
  if (!isset($added[$module][$name])) {
    if ($library = drupal_get_library($module, $name)) {
      // Add all components within the library.
      $elements['#attached'] = array(
        'library' => $library['dependencies'],
        'js' => $library['js'],
        'css' => $library['css'],
      );
      $added[$module][$name] = drupal_process_attached($elements, JS_LIBRARY, TRUE);
    }
    else {
      // Requested library does not exist.
      $added[$module][$name] = FALSE;
    }
  }

  return $added[$module][$name];
}
?>

Login or register to post comments