Official repository for the Cleaner Gallery WordPress plugin.
PHP CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
admin
css
inc
languages
cleaner-gallery.php
license.txt
readme.md
readme.txt
screenshot-1.jpg
screenshot-2.jpg
screenshot-3.jpg
screenshot-4.png

readme.md

Cleaner Gallery

This plugin was written to take care of the invalid HTML that WordPress produces when using the [gallery] shortcode.

It does a bit more than that though. It will integrate with many Lightbox-type scripts and allow you to do much cooler things with your galleries. Plus, it has a couple of extra options that you can play around with.

Features

  • Uses HTML5 <fig> and <figcaption> elements.
  • Integrates with Schema.org microdata.
  • Uses the aria-describedby attribute to make images + captions more accessible to users with disabilities.
  • Validates the invalid code that WordPress spits out.
  • Several options on how you want your gallery images.
  • Allows multiple galleries in a single post.
  • Ability to set the number of images shown in each gallery.
  • Ability to exclude or include any images from your gallery.
  • Doesn't load any extra CSS or JavaScript unless you choose to do so.

Integrates with 18 different Lightbox-type scripts

  1. Lightbox 2
  2. Slimbox
  3. Slimbox 2
  4. Thickbox
  5. Lytebox
  6. Greybox
  7. Lightview
  8. jQuery Lightbox Plugin (balupton edition)
  9. jQuery Lightbox Plugin
  10. Shutter Reloaded
  11. Shadowbox
  12. FancyBox
  13. jQuery Lightbox
  14. LightWindow
  15. FancyZoom
  16. Floatbox
  17. Colorbox
  18. prettyPhoto

Changelog

Version 1.1.0

  • Introduce the Cleaner_Gallery class, which allows for better code reuse and consolidates all the gallery functionality.
  • Add support for Schema.org microdata.
  • Added the .gallery-columns-x class.
  • Added the .gallery-size-x class.
  • Added aria-describedby attribute for images with captions for better accessibility.

Version 1.0.0

  • License change from GPL v2-only to GPL v2+.
  • Rewrote large chunks of the plugin from the ground up.
  • Galleries are now HTML5+, using the <fig> and <figcaption> tags.
  • Dropped the caption link setting because captions in WordPress can now have links within them. Removing the setting was the best way to avoid conflicts.
  • Dropped the Cleaner Gallery stylesheet setting. It caused too much confusion for new users. If you're savvy enough to add styles to your theme, you can handle disabling the stylesheet via the add_theme_support( 'cleaner-gallery' ) method.
  • Much cleaner settings page that now uses the standard Settings API screen design.
  • Upgraded to support all newer WordPress gallery arguments that have been added up to version 3.7.

Version 0.9.1

  • Remove the default feature of overwriting the columns if gallery has too few images since users have asked for this.

Version 0.9

  • Important! Users sould re-save their settings after updating to version 0.9.
  • Completely overhauled the plugin settings page to use the WordPress settings API.
  • Added the option of loading the Cleaner Gallery stylesheet.
  • Made the gallery shortcode script modular, allowing it to be ported to other projects.
  • Added support for the prettyPhoto script.
  • Plugin now only officially supports WordPress 3.0+.

Version 0.8

  • Important! Users sould re-save their settings after updating to version 0.8.
  • Completely recoded the plugin from the ground up for a much needed code overhaul.
  • Added support for the Colorbox script.
  • Added the cleaner_gallery_image_link_class filter hook.
  • Added the cleaner_gallery_image_link_rel filter hook.
  • Removed the link class and rel options in the admin for the more robust filter hooks.
  • Changed the Image Link option to the Default Image Link option, which allows users to always override this setting on a per-post basis.
  • Recognizes custom image sizes created using the add_image_size() WordPress function.
  • Split the plugin into new files so that specific parts of the code are only loaded when needed.
  • Changed the settings page to fully support the screen options and meta box functionality of WordPress.
  • Moved translations to the /languages folder.
  • Added the offset argument so that users could more easily make paginated galleries.

Version 0.7

  • Recoded much of the plugin to be more efficient.
  • Added the cleaner_gallery_id() function to make sure multiple galleries in a single post have different IDs but the same class.
  • Added cleaner_gallery_defaults filter hook.
  • Added cleaner_gallery_default_settings() function to better handle user settings.
  • Moved Lightbox-type image scripts to an external function from the main script (cleaner_gallery_link_attributes()).
  • Deprecated CSS functions in favor of using wp_enqueue_style().'
  • Dropped support for WordPress 2.5.
  • Added support for jQuery Lightbox.
  • Added support for LightWindow.
  • Added support for FancyZoom.
  • Added support for Floatbox.

Version 0.6.1

  • Added numberposts parameter.
  • Added exclude parameter.
  • Added include parameter.

Version 0.6

  • Cleaned up the code to be more efficient and understandable.
  • New options added to the settings page, which include Default Image Size, Default Order, and Default Orderby.
  • Added support for Slimbox 2.
  • Fixed the [gallery columns="0"] error.
  • Fully documented nearly every function and line of code within the PHP files.

Version 0.5

  • Added in an options panel.
  • Support added for Fancybox.

Professional Support

If you need professional plugin support from me, the plugin author, you can access the support forums at Theme Hybrid, which is a professional WordPress help/support site where I handle support for all my plugins and themes for a community of 40,000+ users (and growing).

Copyright and License

This project is licensed under the GNU GPL, version 2 or later.

2008 – 2013 © Justin Tadlock.