/wp-content/themes/news/library/extensions/cleaner-gallery.php
PHP | 166 lines | 76 code | 30 blank | 60 comment | 15 complexity | 20069e9ed7a5eac4ee77475e877b6d79 MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1, AGPL-1.0
- <?php
- /**
- * Cleaner Gallery - A valid image gallery script for WordPress.
- *
- * Cleaner Gallery was created to clean up the invalid HTML and remove the inline styles of the default
- * implementation of the WordPress [gallery] shortcode. This has the obvious benefits of creating
- * sites with clean, valid code. But, it also allows developers to more easily create custom styles for
- * galleries within their themes.
- *
- * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
- * General Public License as published by the Free Software Foundation; either version 2 of the License,
- * or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
- * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- *
- * @package CleanerGallery
- * @version 0.9.4
- * @author Justin Tadlock <justin@justintadlock.com>
- * @copyright Copyright (c) 2008 - 2012, Justin Tadlock
- * @link http://justintadlock.com/archives/2008/04/13/cleaner-wordpress-gallery-plugin
- * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
- */
- /* Filter the post gallery shortcode output. */
- add_filter( 'post_gallery', 'cleaner_gallery', 10, 2 );
- /**
- * Overwrites the default WordPress [gallery] shortcode's output. This function removes the invalid
- * HTML and inline styles. It adds the number of columns used as a class attribute, which allows
- * developers to style the gallery more easily.
- *
- * @since 0.9.0
- * @access private
- * @param string $output
- * @param array $attr
- * @return string $output
- */
- function cleaner_gallery( $output, $attr ) {
- static $cleaner_gallery_instance = 0;
- $cleaner_gallery_instance++;
- /* We're not worried abut galleries in feeds, so just return the output here. */
- if ( is_feed() )
- return $output;
- /* Orderby. */
- if ( isset( $attr['orderby'] ) ) {
- $attr['orderby'] = sanitize_sql_orderby( $attr['orderby'] );
- if ( !$attr['orderby'] )
- unset( $attr['orderby'] );
- }
- /* Default gallery settings. */
- $defaults = array(
- 'order' => 'ASC',
- 'orderby' => 'menu_order ID',
- 'id' => get_the_ID(),
- 'link' => '',
- 'itemtag' => 'dl',
- 'icontag' => 'dt',
- 'captiontag' => 'dd',
- 'columns' => 3,
- 'size' => 'thumbnail',
- 'include' => '',
- 'exclude' => '',
- 'numberposts' => -1,
- 'offset' => ''
- );
- /* Apply filters to the default arguments. */
- $defaults = apply_filters( 'cleaner_gallery_defaults', $defaults );
- /* Apply filters to the arguments. */
- $attr = apply_filters( 'cleaner_gallery_args', $attr );
- /* Merge the defaults with user input. */
- $attr = shortcode_atts( $defaults, $attr );
- extract( $attr );
- $id = intval( $id );
- /* Arguments for get_children(). */
- $children = array(
- 'post_parent' => $id,
- 'post_status' => 'inherit',
- 'post_type' => 'attachment',
- 'post_mime_type' => 'image',
- 'order' => $order,
- 'orderby' => $orderby,
- 'exclude' => $exclude,
- 'include' => $include,
- 'numberposts' => $numberposts,
- 'offset' => $offset,
- 'suppress_filters' => true
- );
- /* Get image attachments. If none, return. */
- $attachments = get_children( $children );
- if ( empty( $attachments ) )
- return '';
- /* Properly escape the gallery tags. */
- $itemtag = tag_escape( $itemtag );
- $icontag = tag_escape( $icontag );
- $captiontag = tag_escape( $captiontag );
- $i = 0;
- /* Count the number of attachments returned. */
- $attachment_count = count( $attachments );
- /* Allow developers to overwrite the number of columns. This can be useful for reducing columns with with fewer images than number of columns. */
- //$columns = ( ( $columns <= $attachment_count ) ? intval( $columns ) : intval( $attachment_count ) );
- $columns = apply_filters( 'cleaner_gallery_columns', intval( $columns ), $attachment_count, $attr );
- /* Open the gallery <div>. */
- $output = "\n\t\t\t<div id='gallery-{$id}-{$cleaner_gallery_instance}' class='gallery gallery-{$id}'>";
- /* Loop through each attachment. */
- foreach ( $attachments as $id => $attachment ) {
- /* Open each gallery row. */
- if ( $columns > 0 && $i % $columns == 0 )
- $output .= "\n\t\t\t\t<div class='gallery-row gallery-clear'>";
- /* Open each gallery item. */
- $output .= "\n\t\t\t\t\t<{$itemtag} class='gallery-item col-{$columns}'>";
- /* Open the element to wrap the image. */
- $output .= "\n\t\t\t\t\t\t<{$icontag} class='gallery-icon'>";
- /* Add the image. */
- $image = ( ( isset( $attr['link'] ) && 'file' == $attr['link'] ) ? wp_get_attachment_link( $id, $size, false, false ) : wp_get_attachment_link( $id, $size, true, false ) );
- $output .= apply_filters( 'cleaner_gallery_image', $image, $id, $attr, $cleaner_gallery_instance );
- /* Close the image wrapper. */
- $output .= "</{$icontag}>";
- /* Get the caption. */
- $caption = apply_filters( 'cleaner_gallery_caption', wptexturize( $attachment->post_excerpt ), $id, $attr, $cleaner_gallery_instance );
- /* If image caption is set. */
- if ( !empty( $caption ) )
- $output .= "\n\t\t\t\t\t\t<{$captiontag} class='gallery-caption'>{$caption}</{$captiontag}>";
- /* Close individual gallery item. */
- $output .= "\n\t\t\t\t\t</{$itemtag}>";
- /* Close gallery row. */
- if ( $columns > 0 && ++$i % $columns == 0 )
- $output .= "\n\t\t\t\t</div>";
- }
- /* Close gallery row. */
- if ( $columns > 0 && $i % $columns !== 0 )
- $output .= "\n\t\t\t</div>";
- /* Close the gallery <div>. */
- $output .= "\n\t\t\t</div><!-- .gallery -->\n";
- /* Return out very nice, valid HTML gallery. */
- return $output;
- }
- ?>