function drupal_add_js in Drupal 6

Same name and namespace in other branches

1. 4 includes/common.inc \drupal_add_js()
2. 5 includes/common.inc \drupal_add_js()
3. 7 includes/common.inc \drupal_add_js()

Add a JavaScript file, setting or inline code to the page.

The behavior of this function depends on the parameters it is called with. Generally, it handles the addition of JavaScript to the page, either as reference to an existing file or as inline code. The following actions can be performed using this function:

• Add a file ('core', 'module' and 'theme'): Adds a reference to a JavaScript file to the page. JavaScript files are placed in a certain order, from 'core' first, to 'module' and finally 'theme' so that files, that are added later, can override previously added files with ease.

• Add inline JavaScript code ('inline'): Executes a piece of JavaScript code on the current page by placing the code directly in the page. This can, for example, be useful to tell the user that a new message arrived, by opening a pop up, alert box etc.

• Add settings ('setting'): Adds a setting to Drupal's global storage of JavaScript settings. Per-page settings are required by some modules to function properly. The settings will be accessible at Drupal.settings.

Parameters

$data: (optional) If given, the value depends on the $type parameter:

• 'core', 'module' or 'theme': Path to the file relative to base_path().
• 'inline': The JavaScript code that should be placed in the given scope.
• 'setting': An array with configuration options as associative array. The array is directly placed in Drupal.settings. You might want to wrap your actual configuration settings in another variable to prevent the pollution of the Drupal.settings namespace.

$type: (optional) The type of JavaScript that should be added to the page. Allowed values are 'core', 'module', 'theme', 'inline' and 'setting'. You can, however, specify any value. It is treated as a reference to a JavaScript file. Defaults to 'module'.

$scope: (optional) The location in which you want to place the script. Possible values are 'header' and 'footer' by default. If your theme implements different locations, however, you can also use these.

$defer: (optional) If set to TRUE, the defer attribute is set on the <script> tag. Defaults to FALSE. This parameter is not used with $type == 'setting'.

$cache: (optional) If set to FALSE, the JavaScript file is loaded anew on every page call, that means, it is not cached. Defaults to TRUE. Used only when $type references a JavaScript file.

$preprocess: (optional) Should this JS file be aggregated if this feature has been turned on under the performance section?

Return value

If the first parameter is NULL, the JavaScript array that has been built so far for $scope is returned. If the first three parameters are NULL, an array with all scopes is returned.

27 calls to drupal_add_js()

block-admin-display-form.tpl.php in modules/block/block-admin-display-form.tpl.php

block-admin-display-form.tpl.php Default theme implementation to configure blocks.

color_scheme_form in modules/color/color.module

Form callback. Returns the configuration form.

comment_form in modules/comment/comment.module

Generate the basic commenting form, for appending to a node or display on a separate page.

drupal_add_tabledrag in includes/common.inc

Assist in adding the tableDrag JavaScript behavior to a themed table.

drupal_get_js in includes/common.inc

Returns a themed presentation of all JavaScript code for the current page.

... See full list

File

includes/common.inc, line 2244

Common functions that many Drupal modules will need to reference.

Code

function drupal_add_js($data = NULL, $type = 'module', $scope = 'header', $defer = FALSE, $cache = TRUE, $preprocess = TRUE) {
  static $javascript = array();
  if (isset($data)) {

    // Add jquery.js and drupal.js, as well as the basePath setting, the
    // first time a Javascript file is added.
    if (empty($javascript)) {
      $javascript['header'] = array(
        'core' => array(
          'misc/jquery.js' => array(
            'cache' => TRUE,
            'defer' => FALSE,
            'preprocess' => TRUE,
          ),
          'misc/drupal.js' => array(
            'cache' => TRUE,
            'defer' => FALSE,
            'preprocess' => TRUE,
          ),
        ),
        'module' => array(),
        'theme' => array(),
        'setting' => array(
          array(
            'basePath' => base_path(),
          ),
        ),
        'inline' => array(),
      );
    }
    if (isset($scope) && !isset($javascript[$scope])) {
      $javascript[$scope] = array(
        'core' => array(),
        'module' => array(),
        'theme' => array(),
        'setting' => array(),
        'inline' => array(),
      );
    }
    if (isset($type) && isset($scope) && !isset($javascript[$scope][$type])) {
      $javascript[$scope][$type] = array();
    }
    switch ($type) {
      case 'setting':
        $javascript[$scope][$type][] = $data;
        break;
      case 'inline':
        $javascript[$scope][$type][] = array(
          'code' => $data,
          'defer' => $defer,
        );
        break;
      default:

        // If cache is FALSE, don't preprocess the JS file.
        $javascript[$scope][$type][$data] = array(
          'cache' => $cache,
          'defer' => $defer,
          'preprocess' => !$cache ? FALSE : $preprocess,
        );
    }
  }
  if (isset($scope)) {
    if (isset($javascript[$scope])) {
      return $javascript[$scope];
    }
    else {
      return array();
    }
  }
  else {
    return $javascript;
  }
}