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:

101 to 200 of 238

  if ( is_feed() ) {
    $output = "\n";
    foreach ( $attachments as $att_id => $attachment ) {
      if ( ! empty( $atts['link'] ) ) {
        if ( 'none' === $atts['link'] ) {
          $output .= wp_get_attachment_image( $att_id, $atts['size'], false, $attr );
        } else {
          $output .= wp_get_attachment_link( $att_id, $atts['size'], false );
        }
      } else {
        $output .= wp_get_attachment_link( $att_id, $atts['size'], true );
      }
      $output .= "\n";
    }
    return $output;
  }

  $itemtag    = tag_escape( $atts['itemtag'] );
  $captiontag = tag_escape( $atts['captiontag'] );
  $icontag    = tag_escape( $atts['icontag'] );
  $valid_tags = wp_kses_allowed_html( 'post' );
  if ( ! isset( $valid_tags[ $itemtag ] ) ) {
    $itemtag = 'dl';
  }
  if ( ! isset( $valid_tags[ $captiontag ] ) ) {
    $captiontag = 'dd';
  }
  if ( ! isset( $valid_tags[ $icontag ] ) ) {
    $icontag = 'dt';
  }

  $columns   = (int) $atts['columns'];
  $itemwidth = $columns > 0 ? floor( 100 / $columns ) : 100;
  $float     = is_rtl() ? 'right' : 'left';

  $selector = "gallery-{$instance}";

  $gallery_style = '';

  
/**
 * Filters whether to print default gallery styles.
 *
 * @since 3.1.0
 *
 * @param bool $print Whether to print default gallery styles.
 *                    Defaults to false if the theme supports HTML5 galleries.
 *                    Otherwise, defaults to true.
 */
  if ( apply_filters( 'use_default_gallery_style', ! $html5 ) ) {
    $type_attr = current_theme_supports( 'html5', 'style' ) ? '' : ' type="text/css"';

    $gallery_style = "
		<style{$type_attr}>
			#{$selector} {
				margin: auto;
			}
			#{$selector} .gallery-item {
				float: {$float};
				margin-top: 10px;
				text-align: center;
				width: {$itemwidth}%;
			}
			#{$selector} img {
				border: 2px solid #cfcfcf;
			}
			#{$selector} .gallery-caption {
				margin-left: 0;
			}
			/* see gallery_shortcode() in wp-includes/media.php */
		</style>\n\t\t";
  }

  $size_class  = sanitize_html_class( is_array( $atts['size'] ) ? implode( 'x', $atts['size'] ) : $atts['size'] );
  $gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>";

  
/**
 * Filters the default gallery shortcode CSS styles.
 *
 * @since 2.5.0
 *
 * @param string $gallery_style Default CSS styles and opening HTML div container
 *                              for the gallery shortcode output.
 */
  $output = apply_filters( 'gallery_style', $gallery_style . $gallery_div );

  $i = 0;

  foreach ( $attachments as $id => $attachment ) {

    $attr = ( trim( $attachment->post_excerpt ) ) ? array( 'aria-describedby' => "$selector-$id" ) : '';

    if ( ! empty( $atts['link'] ) && 'file' === $atts['link'] ) {
      $image_output = wp_get_attachment_link( $id, $atts['size'], false, false, false, $attr );
    } elseif ( ! empty( $atts['link'] ) && 'none' === $atts['link'] ) {
      $image_output = wp_get_attachment_image( $id, $atts['size'], false, $attr );
    } else {
      $image_output = wp_get_attachment_link( $id, $atts['size'], true, false, false, $attr );
    }

 

 View on GitHub View on Trac