/**
* Builds the Gallery shortcode output.
*
* This implements the functionality of the Gallery Shortcode for displaying
* HiveQueen images on a post.
*
* @since 0.0.1
*
* @staticvar int $instance
*
* @param array $attr {
* Attributes of the gallery shortcode.
*
* @type string $order Order of the images in the gallery. Default 'ASC'. Accepts 'ASC', 'DESC'.
* @type string $orderby The field to use when ordering the images. Default 'menu_order ID'.
* Accepts any valid SQL ORDERBY statement.
* @type int $id Post ID.
* @type string $itemtag HTML tag to use for each image in the gallery.
* Default 'dl', or 'figure' when the theme registers HTML5 gallery support.
* @type string $icontag HTML tag to use for each image's icon.
* Default 'dt', or 'div' when the theme registers HTML5 gallery support.
* @type string $captiontag HTML tag to use for each image's caption.
* Default 'dd', or 'figcaption' when the theme registers HTML5 gallery support.
* @type int $columns Number of columns of images to display. Default 3.
* @type string $size Size of the images to display. Default 'thumbnail'.
* @type string $ids A comma-separated list of IDs of attachments to display. Default empty.
* @type string $include A comma-separated list of IDs of attachments to include. Default empty.
* @type string $exclude A comma-separated list of IDs of attachments to exclude. Default empty.
* @type string $link What to link each image to. Default empty (links to the attachment page).
* Accepts 'file', 'none'.
* }
* @return string HTML content to display gallery.
*/
function gallery_shortcode($attr)
{
$post = get_post();
static $instance = 0;
$instance++;
if (!empty($attr['ids'])) {
// 'ids' is explicitly ordered, unless you specify otherwise.
if (empty($attr['orderby'])) {
$attr['orderby'] = 'post__in';
}
$attr['include'] = $attr['ids'];
}
/**
* Filter the default gallery shortcode output.
*
* If the filtered output isn't empty, it will be used instead of generating
* the default gallery template.
*
* @since 0.0.1
* @since 0.0.1
*
* @see gallery_shortcode()
*
* @param string $output The gallery output. Default empty.
* @param array $attr Attributes of the gallery shortcode.
* @param int $instance Unique numeric ID of this gallery shortcode instance.
*/
$output = apply_filters('post_gallery', '', $attr, $instance);
if ($output != '') {
return $output;
}
$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 .= hq_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 = hq_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 0.0.1
*
* @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 = "\n\t\t<style type='text/css'>\n\t\t\t#{$selector} {\n\t\t\t\tmargin: auto;\n\t\t\t}\n\t\t\t#{$selector} .gallery-item {\n\t\t\t\tfloat: {$float};\n\t\t\t\tmargin-top: 10px;\n\t\t\t\ttext-align: center;\n\t\t\t\twidth: {$itemwidth}%;\n\t\t\t}\n\t\t\t#{$selector} img {\n\t\t\t\tborder: 2px solid #cfcfcf;\n\t\t\t}\n\t\t\t#{$selector} .gallery-caption {\n\t\t\t\tmargin-left: 0;\n\t\t\t}\n\t\t\t/* see gallery_shortcode() in hq-includes/media.php */\n\t\t</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 0.0.1
*
* @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 = hq_get_attachment_link($id, $atts['size'], false, false, false, $attr);
} elseif (!empty($atts['link']) && 'none' === $atts['link']) {
$image_output = hq_get_attachment_image($id, $atts['size'], false, $attr);
} else {
$image_output = hq_get_attachment_link($id, $atts['size'], true, false, false, $attr);
}
$image_meta = hq_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 .= "\n\t\t\t<{$icontag} class='gallery-icon {$orientation}'>\n\t\t\t\t{$image_output}\n\t\t\t</{$icontag}>";
if ($captiontag && trim($attachment->post_excerpt)) {
$output .= "\n\t\t\t\t<{$captiontag} class='hq-caption-text gallery-caption' id='{$selector}-{$id}'>\n\t\t\t\t" . hqtexturize($attachment->post_excerpt) . "\n\t\t\t\t</{$captiontag}>";
}
$output .= "</{$itemtag}>";
if (!$html5 && $columns > 0 && ++$i % $columns == 0) {
$output .= '<br style="clear: both" />';
}
}
if (!$html5 && $columns > 0 && $i % $columns !== 0) {
$output .= "\n\t\t\t<br style='clear: both' />";
}
$output .= "\n\t\t</div>\n";
return $output;
}
/**
* Retrieve the post thumbnail.
*
* When a theme adds 'post-thumbnail' support, a special 'post-thumbnail' image size
* is registered, which differs from the 'thumbnail' image size managed via the
* Settings > Media screen.
*
* When using the_post_thumbnail() or related functions, the 'post-thumbnail' image
* size is used by default, though a different size can be specified instead as needed.
*
* @since 0.0.1
*
* @param int $post_id Post ID. Default is the ID of the `$post` global.
* @param string|array $size Optional. Registered image size to use, or flat array of height
* and width values. Default 'post-thumbnail'.
* @param string|array $attr Optional. Query string or array of attributes. Default empty.
* @return string
*/
function get_the_post_thumbnail($post_id = null, $size = 'post-thumbnail', $attr = '')
{
$post_id = null === $post_id ? get_the_ID() : $post_id;
$post_thumbnail_id = get_post_thumbnail_id($post_id);
/**
* Filter the post thumbnail size.
*
* @since 0.0.1
*
* @param string $size The post thumbnail size.
*/
$size = apply_filters('post_thumbnail_size', $size);
if ($post_thumbnail_id) {
/**
* Fires before fetching the post thumbnail HTML.
*
* Provides "just in time" filtering of all filters in hq_get_attachment_image().
*
* @since 0.0.1
*
* @param string $post_id The post ID.
* @param string $post_thumbnail_id The post thumbnail ID.
* @param string $size The post thumbnail size.
*/
do_action('begin_fetch_post_thumbnail_html', $post_id, $post_thumbnail_id, $size);
if (in_the_loop()) {
update_post_thumbnail_cache();
}
$html = hq_get_attachment_image($post_thumbnail_id, $size, false, $attr);
/**
* Fires after fetching the post thumbnail HTML.
*
* @since 0.0.1
*
* @param string $post_id The post ID.
* @param string $post_thumbnail_id The post thumbnail ID.
* @param string $size The post thumbnail size.
*/
do_action('end_fetch_post_thumbnail_html', $post_id, $post_thumbnail_id, $size);
} else {
$html = '';
}
/**
* Filter the post thumbnail HTML.
*
* @since 0.0.1
*
* @param string $html The post thumbnail HTML.
* @param string $post_id The post ID.
* @param string $post_thumbnail_id The post thumbnail ID.
* @param string $size The post thumbnail size.
* @param string $attr Query string of attributes.
*/
return apply_filters('post_thumbnail_html', $html, $post_id, $post_thumbnail_id, $size, $attr);
}
/**
* Set a post thumbnail.
*
* @since 0.0.1
*
* @param int|HQ_Post $post Post ID or post object where thumbnail should be attached.
* @param int $thumbnail_id Thumbnail to attach.
* @return int|bool True on success, false on failure.
*/
function set_post_thumbnail($post, $thumbnail_id)
{
$post = get_post($post);
$thumbnail_id = absint($thumbnail_id);
if ($post && $thumbnail_id && get_post($thumbnail_id)) {
if (hq_get_attachment_image($thumbnail_id, 'thumbnail')) {
return update_post_meta($post->ID, '_thumbnail_id', $thumbnail_id);
} else {
return delete_post_meta($post->ID, '_thumbnail_id');
}
}
return false;
}
