function hook_colorbox_settings_alter in Colorbox 7

Same name and namespace in other branches

1. 8 colorbox.api.php \hook_colorbox_settings_alter()
2. 6 colorbox.api.php \hook_colorbox_settings_alter()
3. 7.2 colorbox.api.php \hook_colorbox_settings_alter()

Allows to override Colorbox settings and style.

Implements hook_colorbox_settings_alter().

Parameters

$settings: An associative array of Colorbox settings. See the Colorbox documentation for the full list of supported parameters.

$style: The name of the active style plugin. If $style is 'none', no Colorbox theme will be loaded.

1 invocation of hook_colorbox_settings_alter()

_colorbox_doheader in ./colorbox.module

Loads the various js and css files.

File

./colorbox.api.php, line 21

API documentation for the colorbox module.

Code

function hook_colorbox_settings_alter(&$settings, &$style) {

  // 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';
  }
}