RPS Image Gallery

RPS Image Gallery enhances the core WordPress gallery function by dynamically adjusting the column count based on viewport width and enabling an image in the gallery to either invoke a slideshow or link to another page, post or any URL. The link and link target are specified in the image’s Edit Media screen using the Gallery Link URL and Gallery Link Target fields. When an image having a Gallery Link URL is clicked, the user will be directed to that location. Images linking elsewhere are automatically excluded from the slideshow – clicking the image will not invoke the slideshow but will call the specified Gallery Link URL.

In addition, RPS Image Gallery combines attachments from multiple posts or pages into a single gallery, enables the use of paging – useful for galleries with a large number of images, and provides the ability to link a gallery image to the post to which it is attached.

Features

• Uses Masonry script for galleries displaying images with various aspect ratios.
• Ability to use installed theme gallery styles while leveraging slideshow capabilities.
• Option to dynamically adjust the number of gallery columns based on viewport width.
• Uses fancyBox or fancyBox2 for slideshow display.
• Autoplays fancyBox or fancyBox2 slideshows.
• Uses thumbnail helpers for fancyBox2 slideshows.
• Uses paging for galleries and ability to specify the number of images per page.
• Uses HTML5 or legacy output for the gallery.
• Supports HTML in the slideshow caption.
• Add Facebook and Pinterest buttons to the gallery view.
• Compatibility settings allowing bundled scripts and styles to be disabled, and unique ‘rps-gallery’ shortcode to be used.
• Clicking gallery images will invoke a slideshow or link to a specified URL, file or parent post.
• Set the target for the image link.
• Supports gallery shortcode defaults which can be overridden for each shortcode instance.
• Combines and sorts attachments from multiple posts into a single gallery.
• Supports multiple galleries appearing on a single page.
• Displays a “download” link/button on the slideshow. (fancyBox2)
• Displays the image title and caption/description in the gallery view.
• Leverages the standard gallery editor interface to specify custom sort order.
• Displays EXIF data in the gallery and/or slideshow.
• Displays gallery thumbnails as background images (legacy format only) or standard images.
• Hides attachments of trashed or future posts in galleries combined using post ids.
• Overrides the default WordPress Gallery shortcode or uses the one provided with the plugin.
• Offers compatibility settings to ensure excellent coexistence with a wide variety of themes and plugins.
• Loads required scripts only when the shortcode is invoked.
  What follows is a comprehensive list of attributes for the gallery shortcode when RPS Image Gallery is active.

id

The post IDs containing a gallery to include.

• ” – single post ID or comma separated list of post IDs (default)

ids

The image IDs to display in the gallery.

• ” – single image ID or comma separated list of image IDs (default)

container

The container for the gallery.

• ‘div’ (default)
• ‘span’

columns

How many columns to use for the gallery view.

• ‘3’ – range is 1 to 9 (default)

responsive_columns

Determines whether the number of columns should respond to the viewport width.

• ‘true’
• ‘false’ (default)

page_size

Determines how many images show at a time. Includes paging navigation. Not compatible with Masonry.

• ‘0’ (default)

align

Affects the heading(title), caption and the last row of images when there are fewer images in the row than number of columns.

• ‘left’ (default)
• ‘center’
• ‘right’

size

The size of the image that should be displayed in the gallery view. It can be any of the standard image sizes including any registered by the theme.

• ‘thumbnail’ (default)
• ‘medium’
• ‘large’
• ‘full’

constrain

Specify if the image dimensions should be constrained by width only or both width and height. Only available with specific themes or when the theme is set to “none”.

• ‘none’ (default)
• ‘media’
• ‘plugin’

constrain_size

Only available if the constrain value is set to ‘media’. Allows the use of the Thumbnail, Medium or Large image dimensions as specified in Media Settings.

• ‘thumbnail’ (default)
• ‘medium’
• ‘large’

constrain_width

Only available if the constrain value is set to ‘plugin’. Allows the constrain width to be specified by the plugin.

• ‘150’ (default)

constrain_height

Only available if the constrain value is set to ‘plugin’. Allows the constrain height to be specified by the plugin.

• ‘150’ (default)

size_large

The size of the image that should be displayed in the slideshow view. It can be any of the standard image sizes including any registered by the theme.

• ‘thumbnail’
• ‘medium’
• ‘large’ (default)
• ‘full’
• ‘custom-size’ (registered image sizes)

orderby

How to sort the images. It is ignored if a list of image IDs is included in the shortcode.

• ‘menu_order’ (default)
• ‘title’
• ‘post_date’
• ‘rand’
• ‘ID’
• ‘post__in’

order

How to order the images. It is ignored if a list of image IDs is included in the shortcode.

• ‘ASC’ (default)
• ‘DESC’

heading

Display the image title in the gallery and slideshow views.

• ‘true’
• ‘false’ (default)

headingtag

The tag that should be used to wrap the image heading (title).

• ‘h1’
• ‘h2’ (default)
• ‘h3’
• ‘h4’
• ‘h5’
• ‘h6’

heading_align

Specify alignment of the heading text presented in the gallery grid.

caption

Display the image caption or description under the images in the gallery grid view.

• ‘true’
• ‘false’ (default)

caption_auto_format

Automatically insert break and paragraph tags into caption.

• ‘true’
• ‘false’ (default)

caption_source

Define where the text presented as the caption should be sourced.

• ‘caption’ (default)
• ‘description’

caption_align

Specify alignment of the caption text presented in the gallery grid.

• ‘left’ (default)
• ‘center’
• ‘right’

link

Where to get the URL to direct a user when clicking/tapping an image. Only has an effect if Slideshow is set to false and the Gallery Link URL is empty.

• ‘permalink’ (default)
• ‘file’
• ‘parent_post’
• ‘none’

html_format

Which HTML structure to use to output the gallery.

• ‘default’ (default)
• ‘html5’

theme

Which theme to use to style the HTML output.

• ‘default’ (default)
• ‘none’

masonry

Whether to use the Masonry script cascading grid layout library for the gallery.

• true
• false (default)

slideshow

Invoke the slideshow (fancyBox) viewer when an image without a Gallery Link URL value is clicked.

• ‘true’ (default)
• ‘false’

fb_version

Which version of fancyBox to use.

• ‘1’ (default)
• ‘2’

autoplay

Specify whether the slideshow should automatically cycle through the images or not.

• ‘true’ (default)
• ‘false’

background_thumbnails

Display the gallery thumbnail images as backgrounds or standard images.

• ‘true’
• ‘false’ (default)

exif

(since 1.2.24)
Show the EXIF image data.

• ‘true’
• ‘false’ (default)

exif_locations

Where to show the EXIF data associated with the image.

• ‘gallery’
• ‘slideshow’ (default)
• ‘both’

exif_fields

What EXIF fields to display and in what order.

• ‘camera,aperture,focal_length,iso,shutter_speed,title,caption,credit,copyright,created_timestamp’ (default)

include

Comma separated attachment IDs to display. Cannot be used with exclude.

• ” (default)

exclude

Comma separated attachment IDs to display. Cannot be used with include.

• ” (default)

group_name

The class of the gallery group which determines what images belong to the gallery slideshow.

• ‘rps-image-group’ (default)

alt_caption_fallback

Use the ALT value as a fallback in case the Caption field is empty.

• ‘true’ (default)
• ‘false’

fb_title_show

Show the title area in the slideshow view including the image heading, caption or description, and EXIF data.

• ‘true’ (default)
• ‘false’

fb_heading

Show the image heading within the title area of the slideshow.

• ‘true’ (default)
• ‘false’

fb_caption

Show the image caption within the title area of the slideshow.

• ‘true’ (default)
• ‘false’

fb_title_position

The position of the title area in relation to the image in the slideshow.

• ‘over’ (default)
• ‘outside’
• ‘inside’

fb_title_align

The alignment of the text in the slideshow title.

• ‘none’ (default)
• ‘left’
• ‘center’
• ‘right’

fb_show_close_button

Show the close button in the upper-right corner of the slideshow (clicking outside the slideshow always closes it).

• ‘true’ (default)
• ‘false’

fb_transition_in

The effect that should be used when the slideshow is opened.

• ‘none’ (default)
• ‘elastic’
• ‘fade’

fb_transition_out

The effect that should be used when the slideshow is closed.

• ‘none’ (default)
• ‘elastic’
• ‘fade’

fb_speed_in

Time in milliseconds of the fade and transition when the slideshow is opened.

• ‘300’ – minimum of 100 and maximum of 1000 (default)

fb_speed_out

Time in milliseconds of the fade and transition when the slideshow is closed.

• ‘300’ – minimum of 100 and maximum of 1000 (default)

fb_title_counter_show

Display the image counter in the slideshow (i.e. “Image 1/10).

• ‘true’ (default)
• ‘false’

fb_cyclic

Make the slideshow start from the beginning once the end is reached.

• ‘true’ (default)
• ‘false’

fb_center_on_scroll

Center the image on the screen while scrolling the page.

• ‘true’ (default)
• ‘false’

fb_padding

Space between FancyBox wrapper and content.

• ’10’ – minimum of 0px and maximum of 100px (default)

fb_margin

Space between viewport and FancyBox wrapper.

• ’20’ – minimum of 0px and maximum of 100px (default)

fb_overlay_opacity

Opacity of the overlay appearing behind the slideshow and on top of the page.

• ‘0.3’ – minimum of 0 and maximum of 1 (default)

fb_overlay_color

Color of the overlay appearing behind the slideshow and on top of the page.

• ‘#666’ (default)

fb_helper_thumbs

Display helper thumbnails appearing below the slideshow in fancyBox2.

• ‘true’
• ‘false’ (default)

fb_helper_thumbs_width

The width of the helper thumbnails appearing below the slideshow in fancyBox2.

• 50 (default)

fb_helper_thumbs_height

The height of the helper thumbnails appearing below the slideshow in fancyBox2.

• 50 (default)

native

Set to true if it is preferred the native WordPress gallery output is used.

• ‘true’
• ‘false’ (default)