WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Difference between revisions of "User:DrewAPicture/gallery shortcode"

(Options)
Line 14: Line 14:
   
   
== Examples ==
+
== Output Options ==
   
 
There are several options that may be specified using this syntax:
 
There are several options that may be specified using this syntax:
Line 30: Line 30:
 
print apply_filters( 'the_content', $gallery_shortcode );
 
print apply_filters( 'the_content', $gallery_shortcode );
 
?>
 
?>
  +
   
 
== Options ==
 
== Options ==
 
; orderby : specify how to sort the display thumbnails. The default is "menu_order". Options:
 
* menu_order - you can reorder the images in the Gallery tab of the Add Media pop-up
 
* title - order by the title of the image in Media
 
* post_date - sort by date/time
 
* rand - order randomly
 
* ID
 
 
; order : specify the sort order used to display thumbnails. ASC or DESC. For example, to sort by ID, DESC:
 
 
[gallery order="DESC" orderby="ID"]
 
 
; columns : specify the number of columns. The gallery will include a break tag at the end of each row, and calculate the column width as appropriate. The default value is 3. If columns is set to 0, no row breaks will be included. For example, to display a 4 column gallery:
 
 
[gallery columns="4"]
 
 
; id : specify the post ID. The gallery will display images which are attached to that post. The default behavior if no ID is specified is to display images attached to the current post. For example, to display images attached to post 123:
 
 
[gallery id="123"]
 
 
; size : specify the image size to use for the thumbnail display. Valid values include "thumbnail", "medium", "large", "full" and any other additional image size that was registered with [[Function Reference/add_image_size | add_image_size()]]. The default value is "thumbnail". The size of the images for "thumbnail", "medium" and "large" can be configured in WordPress admin panel under Settings > Media. For example, to display a gallery of medium sized images:
 
 
[gallery size="medium"]
 
 
Some advanced options are available:
 
 
; itemtag : the name of the XHTML tag used to enclose each item in the gallery. The default is "dl".
 
 
; icontag : the name of the XHTML tag used to enclose each thumbnail icon in the gallery. The default is "dt".
 
 
; captiontag: the name of the XHTML tag used to enclose each caption. The default is "dd". For example, to change the gallery markup to use div, span and p tags:
 
 
[gallery itemtag="div" icontag="span" captiontag="p"]
 
 
; link: you can set it to "file" so each image will link to the image file. The default value links to the attachment's permalink.
 
 
[gallery link="file"]
 
 
; include: comma separated attachment IDs to show only the images from these attachments.
 
 
[gallery include="23,39,45"]
 
 
; exclude: comma separated attachment IDs excludes the images from these attachments. Please note that '''include''' and '''exclude''' cannot be used together.
 
 
[gallery exclude="21,32,43"]
 
 
[[Category:Advanced Topics]]
 
[[Category:WordPress Development]]
 
[[Category:Shortcodes]]
 
 
== Examples ==
 
 
There are several options that may be specified using this syntax:
 
 
[gallery option1="value1" option2="value2"]
 
 
You can also print a gallery directly in a template like so:
 
 
<?php echo do_shortcode('[gallery option1="value1"]'); ?>
 
 
This works too:
 
 
<?php
 
$gallery_shortcode = '[gallery id="' . intval( $post->post_parent ) . '"]';
 
print apply_filters( 'the_content', $gallery_shortcode );
 
?>
 
 
== Parameters ==
 
 
The following basic options are supported:
 
   
 
; orderby : specify how to sort the display thumbnails. The default is "menu_order". Options:
 
; orderby : specify how to sort the display thumbnails. The default is "menu_order". Options:

Revision as of 22:07, 14 December 2012

Gallery Shortcode Tryout

In WordPress, the Gallery feature allows you to one or more image galleries to your posts and pages. Up until WordPress 3.5, the gallery shortcode was most often used in this form:

[gallery]

Following 3.5, it's more likely you'll see gallery shortcodes similar to this format:

[gallery ids="729,732,731,720"]

This new-ish format (which was previously possible), allows you to include images in your gallery that aren't necessarily "attached" to your post — that is to say, not uploaded from within your post or page. This flexibility allows you to create and embed any number of galleries containing any number of images!

Note: If you choose to just use the [gallery] shortcode in your post or page, the shortcode will only include images that are "attached" to that post or page. This is not new behavior to 3.5.


Output Options

There are several options that may be specified using this syntax:

[gallery option1="value1" option2="value2"]

You can also print a gallery directly in a template like so:

 <?php echo do_shortcode('[gallery option1="value1"]'); ?>

This works too:

 <?php
    $gallery_shortcode = '[gallery id="' . intval( $post->post_parent ) . '"]';
    print apply_filters( 'the_content', $gallery_shortcode );
 ?>


Options

orderby 
specify how to sort the display thumbnails. The default is "menu_order". Options:
  • menu_order - you can reorder the images in the Gallery tab of the Add Media pop-up
  • title - order by the title of the image in Media
  • post_date - sort by date/time
  • rand - order randomly
  • ID
order 
specify the sort order used to display thumbnails. ASC or DESC. For example, to sort by ID, DESC:
 [gallery order="DESC" orderby="ID"]
columns 
specify the number of columns. The gallery will include a break tag at the end of each row, and calculate the column width as appropriate. The default value is 3. If columns is set to 0, no row breaks will be included. For example, to display a 4 column gallery:
[gallery columns="4"]
id 
specify the post ID. The gallery will display images which are attached to that post. The default behavior if no ID is specified is to display images attached to the current post. For example, to display images attached to post 123:
[gallery id="123"]
size 
specify the image size to use for the thumbnail display. Valid values include "thumbnail", "medium", "large", "full" and any other additional image size that was registered with add_image_size(). The default value is "thumbnail". The size of the images for "thumbnail", "medium" and "large" can be configured in WordPress admin panel under Settings > Media. For example, to display a gallery of medium sized images:
[gallery size="medium"]

Some advanced options are available:

itemtag 
the name of the XHTML tag used to enclose each item in the gallery. The default is "dl".
icontag 
the name of the XHTML tag used to enclose each thumbnail icon in the gallery. The default is "dt".
captiontag
the name of the XHTML tag used to enclose each caption. The default is "dd". For example, to change the gallery markup to use div, span and p tags:
[gallery itemtag="div" icontag="span" captiontag="p"]
link
you can set it to "file" so each image will link to the image file. The default value links to the attachment's permalink.
[gallery link="file"] 
include
comma separated attachment IDs to show only the images from these attachments.
[gallery include="23,39,45"] 
exclude
comma separated attachment IDs excludes the images from these attachments. Please note that include and exclude cannot be used together.
[gallery exclude="21,32,43"]