General parameters

parameter description example
type

The gallery type. Note: if you choose the native gallery all the other options will be ignored!

Possible values

  • rgg : Responsive Gallery Grid
  • native : Native Gallery

Default value : rgg

 [gallery type="rgg" ids="1,2,3"]
link_to

What happens when a gallery image is clicked. "Enlarge on click" opens the lightbox (engine chosen below); the others link or do nothing.

Possible values

  • none : Nothing
  • media : Media File
  • attachment : Attachment Page
  • lightbox : Enlarge on click

Default value : lightbox

 [gallery link_to="lightbox" ids="1,2,3"]
lightbox

Choose your lightbox configuration

Possible values

  • simplelightbox : SimpleLightbox
  • native : WP default lightbox
  • image-above : Active image above gallery

Default value : native

 [gallery lightbox="native" ids="1,2,3"]

Display parameters

parameter description example
margin

A positive integer value indicating the number of pixels you want to appear between the images in the Responsive Gallery.

Default value : 2

 [gallery margin="2" ids="1,2,3"]
maxrowheight

A positive integer value indicating the maximum height, in pixels, of each row in the Responsive Gallery Grid.

Default value : 200

 [gallery maxrowheight="200" ids="1,2,3"]
lastrowbehavior

Choose how the last row should behave

Possible values

  • normal : Normal
  • last_row_same_height : Force same height as previous row
  • force_justified : Force justified
  • center : Center the last row
  • align_right : Align last row to the right
  • hide : Hide last row if not full

Default value : last_row_same_height

 [gallery lastrowbehavior="center" ids="1,2,3"]

Animation parameters

parameter description example
scale

A positive decimal value indicating the factor by which the image-size is multiplied on mouse over.

Default value : 1.1

 [gallery scale="1.1" ids="1,2,3"]
intime

A positive integer value indicating the time, in milliseconds, it will take for the mouse over animation to complete.

Default value : 100

 [gallery intime="100" ids="1,2,3"]
outtime

A positive integer value indicating the time, in milliseconds, it will take for the mouse out animation to complete.

Default value : 100

 [gallery outtime="100" ids="1,2,3"]
effect

Choose the mouse-over effect

Possible values

  • bubble : Bubble
  • fade : Fade
  • zoom : Zoom
  • none : None

Default value : bubble

 [gallery effect="bubble" ids="1,2,3"]

Captions

parameter description example
captions

Choose how you want the captions to be displayed. Note: you can create custom caption styles.

Possible values

  • title : As title attribute
  • overlay : Overlay
  • overlay-hover-show : Overlay: show on mouse-over
  • overlay-hover-hide : Overlay: hide on mouse-over
  • off : Don't show captions
  • custom : Custom style

Default value : overlay-hover-show

 [gallery captions="overlay-hover-show" ids="1,2,3"]
captions_effect

Choose an animation effect

Possible values

  • none : None
  • fade : Fade in/out
  • slide_up : Slide up/down

Default value : slide_up

 [gallery captions_effect="slide_up" ids="1,2,3"]
captions_intime

A positive integer value indicating the time, in milliseconds, it will take for the caption mouse over effect to complete.

Default value : 200

 [gallery captions_intime="200" ids="1,2,3"]
captions_outtime

A positive integer value indicating the time, in milliseconds, it will take for the caption mouse over effect to complete.

Default value : 200

 [gallery captions_outtime="200" ids="1,2,3"]

Native parameters

These are parameters that will work with the native gallery as well.

parameter description example
orderby

Choose which default order you would like to use for the gallery images

Possible values

  • menu_order : Use the order you chose manually
  • ID : Order by media ID
  • title : Order by title
  • date : Order by the date and time the image was uploaded
  • modified : Order by the date and time the image was last modified
  • rand : Random order

Default value : menu_order

 [gallery orderby="menu_order" ids="1,2,3"]
link

Choose where the gallery images should link to

Possible values

  • post : Attachment Page
  • file : Media File
  • none : None

Default value : file

 [gallery link="file" ids="1,2,3"]
size

The size of the images to load as the tiles of the grid.

Possible values

  • thumbnail : thumbnail
  • medium : medium
  • medium_large : medium_large
  • large : large
  • 1536x1536 : 1536x1536
  • 2048x2048 : 2048x2048
  • post-thumbnail : post-thumbnail
  • full : full

Default value : medium

 [gallery size="medium" ids="1,2,3"]
ids

A comma seperated list of media IDs.
This is generated by WordPress if you create a Gallery with Add Media. If this parameter is omitted, the gallery will show all images that are attached to the current post.

 [gallery ids="1,2,3"]

Advanced native parameters

They are kind of useless in my opinion.

parameter description example
include

A comma seperated list of media IDs of additional images to include in the gallery.

 [gallery include="4,5" ids="1,2,3"]
exclude

A comma seperated list of media IDs of images to exclude from the gallery.

 [gallery exclude="2" ids="1,2,3"]
id

A valid Post ID. This will only be used if the ids parameter is omitted.
Fills the gallery with all images attached to the post with the provided ID.
Default value is the ID of the post in which the gallery is inserted.

 [gallery id="5"]