You are here

colorbox-insert-image.tpl.php in Colorbox 7.2

Same filename and directory in other branches
  1. 6 colorbox-insert-image.tpl.php
  2. 7 colorbox-insert-image.tpl.php

Template file for Colorbox content inserted via the Insert module.

Available variables:

  • $item: The complete item being inserted.
  • $url: The URL to the image.
  • $path: The URL to the image that Colorbox should open.
  • $class: A set of classes assigned to this image (if any).
  • $width: The width of the image (if known).
  • $height: The height of the image (if known).
  • $style_name: The Image style being used.
  • $gallery_id: The ID of the Colorbox gallery.

Note that ALT and Title fields should not be filled in here, instead they should use placeholders that will be updated through JavaScript when the image is inserted.

Available placeholders:

  • __alt__: The ALT text, intended for use in the <img> tag.
  • __title__: The Title text, intended for use in the <img> tag.
  • __description__: A description of the image, sometimes used as a caption.
  • __filename__: The file name.
  • __[token]_or_filename__: Any of the above tokens if available, otherwise use the file's name. i.e. __title_or_filename__.

File

colorbox-insert-image.tpl.php
View source
<?php

/**
 * @file
 * Template file for Colorbox content inserted via the Insert module.
 *
 * Available variables:
 * - $item: The complete item being inserted.
 * - $url: The URL to the image.
 * - $path: The URL to the image that Colorbox should open.
 * - $class: A set of classes assigned to this image (if any).
 * - $width: The width of the image (if known).
 * - $height: The height of the image (if known).
 * - $style_name: The Image style being used.
 * - $gallery_id: The ID of the Colorbox gallery.
 *
 * Note that ALT and Title fields should not be filled in here, instead they
 * should use placeholders that will be updated through JavaScript when the
 * image is inserted.
 *
 * Available placeholders:
 * - __alt__: The ALT text, intended for use in the <img> tag.
 * - __title__: The Title text, intended for use in the <img> tag.
 * - __description__: A description of the image, sometimes used as a caption.
 * - __filename__: The file name.
 * - __[token]_or_filename__: Any of the above tokens if available, otherwise
 *   use the file's name. i.e. __title_or_filename__.
 */
?>
<a href="<?php

print $path;
?>" title="__title__" class="colorbox colorbox-insert-image" data-colorbox-gallery="<?php

print $gallery_id;
?>">
  <img src="<?php

print $url;
?>" <?php

if ($width && $height) {
  ?>width="<?php

  print $width;
  ?>" height="<?php

  print $height;
  ?>" <?php

}
?>alt="__alt__" title="__title__" class="<?php

print $class;
?>" />
</a>