1 custom data-gall – 2 not set

Just another responsive WordPress jQuery lightbox plugin
To manipulate the linked images, specifically the links themselves in the WordPress Gallery output for doing things like adding in a CSS class or a data attribute value you can use the post_gallery filter in /wp-includes/media.php which is the right tool for the job.
The filter can be applied like so…
<?php | |
add_filter( 'post_gallery', 'themeprefix_gallery_output', 10, 3); | |
function themeprefix_gallery_output($output, $attr, $instance ) { | |
global $post, $wp_locale; | |
$html5 = current_theme_supports( 'html5', 'gallery' ); | |
$atts = shortcode_atts( array( | |
'order' => 'ASC', | |
'orderby' => 'menu_order ID', | |
'id' => $post ? $post->ID : 0, | |
'itemtag' => $html5 ? 'figure' : 'dl', | |
'icontag' => $html5 ? 'div' : 'dt', | |
'captiontag' => $html5 ? 'figcaption' : 'dd', | |
'columns' => 3, | |
'size' => 'thumbnail', | |
'include' => '', | |
'exclude' => '', | |
'link' => '' | |
), $attr, 'gallery' ); | |
$id = intval( $atts['id'] ); | |
if ( ! empty( $atts['include'] ) ) { | |
$_attachments = get_posts( array( 'include' => $atts['include'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) ); | |
$attachments = array(); | |
foreach ( $_attachments as $key => $val ) { | |
$attachments[$val->ID] = $_attachments[$key]; | |
} | |
} elseif ( ! empty( $atts['exclude'] ) ) { | |
$attachments = get_children( array( 'post_parent' => $id, 'exclude' => $atts['exclude'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) ); | |
} else { | |
$attachments = get_children( array( 'post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) ); | |
} | |
if ( empty( $attachments ) ) { | |
return ''; | |
} | |
if ( is_feed() ) { | |
$output = "\n"; | |
foreach ( $attachments as $att_id => $attachment ) { | |
$output .= wp_get_attachment_link( $att_id, $atts['size'], true ) . "\n"; | |
} | |
return $output; | |
} | |
$itemtag = tag_escape( $atts['itemtag'] ); | |
$captiontag = tag_escape( $atts['captiontag'] ); | |
$icontag = tag_escape( $atts['icontag'] ); | |
$valid_tags = wp_kses_allowed_html( 'post' ); | |
if ( ! isset( $valid_tags[ $itemtag ] ) ) { | |
$itemtag = 'dl'; | |
} | |
if ( ! isset( $valid_tags[ $captiontag ] ) ) { | |
$captiontag = 'dd'; | |
} | |
if ( ! isset( $valid_tags[ $icontag ] ) ) { | |
$icontag = 'dt'; | |
} | |
$columns = intval( $atts['columns'] ); | |
$itemwidth = $columns > 0 ? floor(100/$columns) : 100; | |
$float = is_rtl() ? 'right' : 'left'; | |
$selector = "gallery-{$instance}"; | |
$gallery_style = ''; | |
/** | |
* Filter whether to print default gallery styles. | |
* | |
* @since 3.1.0 | |
* | |
* @param bool $print Whether to print default gallery styles. | |
* Defaults to false if the theme supports HTML5 galleries. | |
* Otherwise, defaults to true. | |
*/ | |
if ( apply_filters( 'use_default_gallery_style', ! $html5 ) ) { | |
$gallery_style = " | |
<style type='text/css'> | |
#{$selector} { | |
margin: auto; | |
} | |
#{$selector} .gallery-item { | |
float: {$float}; | |
margin-top: 10px; | |
text-align: center; | |
width: {$itemwidth}%; | |
} | |
#{$selector} img { | |
border: 2px solid #cfcfcf; | |
} | |
#{$selector} .gallery-caption { | |
margin-left: 0; | |
} | |
/* see gallery_shortcode() in wp-includes/media.php */ | |
</style>\n\t\t"; | |
} | |
$size_class = sanitize_html_class( $atts['size'] ); | |
$gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>"; | |
/** | |
* Filter the default gallery shortcode CSS styles. | |
* | |
* @since 2.5.0 | |
* | |
* @param string $gallery_style Default CSS styles and opening HTML div container | |
* for the gallery shortcode output. | |
*/ | |
$output = apply_filters( 'gallery_style', $gallery_style . $gallery_div ); | |
$i = 0; | |
foreach ( $attachments as $id => $attachment ) { | |
$attr = ( trim( $attachment->post_excerpt ) ) ? array( 'aria-describedby' => "$selector-$id" ) : ''; | |
if ( ! empty( $atts['link'] ) && 'file' === $atts['link'] ) { | |
$image_output = wp_get_attachment_link( $id, $atts['size'], false, false, false, $attr ); | |
} elseif ( ! empty( $atts['link'] ) && 'none' === $atts['link'] ) { | |
$image_output = wp_get_attachment_image( $id, $atts['size'], false, $attr ); | |
} else { | |
$image_output = wp_get_attachment_link( $id, $atts['size'], true, false, false, $attr ); | |
} | |
$image_meta = wp_get_attachment_metadata( $id ); | |
$orientation = ''; | |
if ( isset( $image_meta['height'], $image_meta['width'] ) ) { | |
$orientation = ( $image_meta['height'] > $image_meta['width'] ) ? 'portrait' : 'landscape'; | |
} | |
$output .= "<{$itemtag} class='gallery-item'>"; | |
$output .= " | |
<{$icontag} class='gallery-icon {$orientation}'> | |
$image_output | |
</{$icontag}>"; | |
if ( $captiontag && trim($attachment->post_excerpt) ) { | |
$output .= " | |
<{$captiontag} class='wp-caption-text gallery-caption' id='$selector-$id'> | |
" . wptexturize($attachment->post_excerpt) . " | |
</{$captiontag}>"; | |
} | |
$output .= "</{$itemtag}>"; | |
if ( ! $html5 && $columns > 0 && ++$i % $columns == 0 ) { | |
$output .= '<br style="clear: both" />'; | |
} | |
} | |
if ( ! $html5 && $columns > 0 && $i % $columns !== 0 ) { | |
$output .= " | |
<br style='clear: both' />"; | |
} | |
$output .= " | |
</div>\n"; | |
return $output; | |
} |
So this is an exact copy of the original with nothing actually changed in the filter at this point, you can change what you like to suit your needs, the highlighted line is what controls the link around the image and is not easily manipulated.
So instead of using wp_get_attachment_link as the $image_output, you can build the HTML link and use wp_attachment_url as the href value for the clicked image and then use wp_get_attachment_image for the actual image it is surrounding.
So this would be our new $image_output
$image_output = "<a href='" . wp_get_attachment_url( $id ) . "'> " . wp_get_attachment_image($id, $atts['size'], false, $attr ) . "</a>";
$image_output = "<a href='" . wp_get_attachment_url( $id ) . "'> " . wp_get_attachment_image($id, $atts['size'], false, $attr ) . "</a>"; |
Now that the html is editable you can easily add a class or data attribute.
Say if you wanted a unique class or data attribute for each gallery (if more than one appeared on the page) you can take advantage of the $instance parameter which is a unique ID of each gallery, which you could append to your class to data attribute value.
data-gall='gallery-{$instance}'
or
class='gallery-class-{$instance}'
So if more than one gallery existed on the page they would have these values incremented by 1.
$image_output = "<a href='" . wp_get_attachment_url( $id ) . "' data-gall='gallery-{$instance}'> " . wp_get_attachment_image($id, $atts['size'], false, $attr ) . "</a>"; |
That’s it, manipulate away!
Multiple galleries on a page work independently of each other in lightbox mode.
Gallery One
Gallery Two
You can add a data attribute and value to a WordPress gallery via jQuery
jQuery(document).ready(function($){ $('#gallery-1 a').each(function() { $(this).attr('data-gall', 'gallery-mine' ); }); });
So above we are targetting the a link tags that are the descendants of the gallery with an id of #gallery-1
They are then given a data attribute of data-gall and a value of gallery-mine.