colorbox.api.php in Colorbox 7.2

API documentation for the colorbox module.

File

colorbox.api.php

<?php

/**
 * @file
 * API documentation for the colorbox module.
 */

/**
 * Allows to override Colorbox settings and style.
 *
 * Implements hook_colorbox_settings_alter().
 *
 * @param array $settings
 *   An associative array of Colorbox settings. See the.
 * @param string $style
 *   The name of the active style plugin. If $style is 'none', no Colorbox
 *   theme will be loaded.
 *
 * @link http://colorpowered.com/colorbox/ Colorbox documentation @endlink
 *   for the full list of supported parameters.
 *
 * @codingStandardsIgnoreStart
 */
function hook_colorbox_settings_alter(&$settings, &$style) {

  // @codingStandardsIgnoreEnd.
  // Disable automatic downscaling of images to maxWidth/maxHeight size.
  $settings['scalePhotos'] = FALSE;

  // Use custom style plugin specifically for node/123.
  if ($_GET['q'] == 'node/123') {
    $style = 'mystyle';
  }
}

/**
 * Allows to override activation of Colorbox for the current URL.
 *
 * @param bool $active
 *   A boolean indicating whether colorbox should be active for the current
 *   URL or not.
 */
function hook_colorbox_active_alter(&$active) {
  $path = drupal_get_path_alias($_GET['q']);
  if (drupal_match_path($path, 'admin/config/colorbox_test')) {

    // Enable colorbox for this URL.
    $active = TRUE;
  }
}

Functions

Name	Description
hook_colorbox_active_alter	Allows to override activation of Colorbox for the current URL.
hook_colorbox_settings_alter	Allows to override Colorbox settings and style.