gallery_shortcode() – Builds the Gallery shortcode output.

You appear to be a bot. Output may be restricted

Description

Builds the Gallery shortcode output.

This implements the functionality of the Gallery Shortcode for displaying WordPress images on a post.

Usage

$string = gallery_shortcode( $attr );

Parameters

$attr
( array ) required – { Attributes of the gallery shortcode.
$order
( string ) required – Order of the images in the gallery. Default 'ASC'. Accepts 'ASC', 'DESC'.
$orderby
( string ) required – The field to use when ordering the images. Default 'menu_order ID'. Accepts any valid SQL ORDERBY statement.
$id
( int ) required – Post ID.
$itemtag
( string ) required – HTML tag to use for each image in the gallery. Default 'dl', or 'figure' when the theme registers HTML5 gallery support.
$icontag
( string ) required – HTML tag to use for each image's icon. Default 'dt', or 'div' when the theme registers HTML5 gallery support.
$captiontag
( string ) required – HTML tag to use for each image's caption. Default 'dd', or 'figcaption' when the theme registers HTML5 gallery support.
$columns
( int ) required – Number of columns of images to display. Default 3.
$size
( string|int[] ) required – Size of the images to display. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'thumbnail'.
$ids
( string ) required – A comma-separated list of IDs of attachments to display. Default empty.
$include
( string ) required – A comma-separated list of IDs of attachments to include. Default empty.
$exclude
( string ) required – A comma-separated list of IDs of attachments to exclude. Default empty.
$link
( string ) required – What to link each image to. Default empty (links to the attachment page). Accepts 'file', 'none'. }

Returns

string HTML content to display gallery.

Source

File name: wordpress/wp-includes/media.php
Lines:

201 to 238 of 238
    $image_meta = wp_get_attachment_metadata( $id );

    $orientation = '';

    if ( isset( $image_meta['height'], $image_meta['width'] ) ) {
      $orientation = ( $image_meta['height'] > $image_meta['width'] ) ? 'portrait' : 'landscape';
    }

    $output .= "<{$itemtag} class='gallery-item'>";
    $output .= "
			<{$icontag} class='gallery-icon {$orientation}'>
				$image_output
			</{$icontag}>";

    if ( $captiontag && trim( $attachment->post_excerpt ) ) {
      $output .= "
				<{$captiontag} class='wp-caption-text gallery-caption' id='$selector-$id'>
				" . wptexturize( $attachment->post_excerpt ) . "
				</{$captiontag}>";
    }

    $output .= "</{$itemtag}>";

    if ( ! $html5 && $columns > 0 && 0 === ++$i % $columns ) {
      $output .= '<br style="clear: both" />';
    }
  }

  if ( ! $html5 && $columns > 0 && 0 !== $i % $columns ) {
    $output .= "
			<br style='clear: both' />";
  }

  $output .= "
		</div>\n";

  return $output;
}
 

 View on GitHub View on Trac