Image title as text description for colorbox image formatter (Drupal 7)

Author: 
Anton Sidashin
Parent Feed: 
Pixeljets

When you have core “image” field on your node type and you want to output “title” (or “alt”) of this image just under the image thumbnail as text - you can use image_caption_formatter module for that.
But only in the case when you don’t need another image formatter in place - e.g. Colorbox - because Colorbox provides its own image formatter, and image_caption_formatter module also provides its own image formatter. You obviously can’t use two formatters at the same time.

So, when I was asked to set up such image caption for Colorbox multiple image field, I had to spend a bit of time to find better way.

For Colorbox case, it’s just the matter of one theme call override!

Colorbox module has theme_colorbox_imagefield() function, and here is the modified version of the function (1 line change) that you need to put to your theme:

<?php
function YOURTHEME_colorbox_imagefield($variables) {
    $class = array('colorbox');  if ($variables['image']['style_name'] == 'hide') {
    $image = '';
    $class[] = 'js-hide';
  }
  else if (!empty($variables['image']['style_name'])) {
    $image = theme('image_style', $variables['image']);   
  }
  else {
    $image = theme('image', $variables['image']);
  }  // ##### Here are the lines I've added
  $my_style = 'my_style_that_should_come_with_a_caption';
  if ($variables['image']['style_name'] == $my_style) {
    $image .= '<span class="img-title">' . check_plain($variables['title']) . '</span>';
  }
  // ##### end of modification  $options = array(
    'html' => TRUE,
    'attributes' => array(
      'title' => $variables['title'],
      'class' => implode(' ', $class),
      'rel' => $variables['gid'],
    )
  );  return l($image, $variables['path'], $options);
}
?>

Super-easy! But I hope this post may save several minutes for somebody :)

Note that if you want to output “alt” of the image, not “title”, you should change $variables[‘image’][‘title’] to $variables[‘image’][‘alt’].

UPD: some code improvements, from fietserwin

27 August, 2012

Original Post: 
http://pixeljets.com/blog/image-title-text-description-colorbox-image-formatter-drupal-7
RSS Tags: 
Drupal Planet