Question

gallery_shortcode( array $attr )

Builds the Gallery shortcode output.

---

description

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

---

参数

$attr

(array) (Required) Attributes of the gallery shortcode.

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

---

返回值

(string) HTML content to display gallery.

---

源代码

File: wp-includes/media.php

function gallery_shortcode( $attr ) {
	$post = get_post();

	static $instance = 0;
	$instance++;

	if ( ! empty( $attr['ids'] ) ) {
		// 'ids' is explicitly ordered, unless you specify otherwise.
		if ( empty( $attr['orderby'] ) ) {
			$attr['orderby'] = 'post__in';
		}
		$attr['include'] = $attr['ids'];
	}

	/**
	 * Filters the default gallery shortcode output.
	 *
	 * If the filtered output isn't empty, it will be used instead of generating
	 * the default gallery template.
	 *
	 * @since 2.5.0
	 * @since 4.2.0 The `$instance` parameter was added.
	 *
	 * @see gallery_shortcode()
	 *
	 * @param string $output   The gallery output. Default empty.
	 * @param array  $attr     Attributes of the gallery shortcode.
	 * @param int    $instance Unique numeric ID of this gallery shortcode instance.
	 */
	$output = apply_filters( 'post_gallery', '', $attr, $instance );
	if ( $output != '' ) {
		return $output;
	}

	$html5 = current_theme_supports( 'html5', 'gallery' );
	$atts = shortcode_atts( array(
		'order'      => 'ASC',
		'orderby'    => 'menu_order ID',
		'id'         => $post ? $post->ID : 0,
		'itemtag'    => $html5 ? 'figure'     : 'dl',
		'icontag'    => $html5 ? 'div'        : 'dt',
		'captiontag' => $html5 ? 'figcaption' : 'dd',
		'columns'    => 3,
		'size'       => 'thumbnail',
		'include'    => '',
		'exclude'    => '',
		'link'       => ''
	), $attr, 'gallery' );

	$id = intval( $atts['id'] );

	if ( ! empty( $atts['include'] ) ) {
		$_attachments = get_posts( array( 'include' => $atts['include'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );

		$attachments = array();
		foreach ( $_attachments as $key => $val ) {
			$attachments[$val->ID] = $_attachments[$key];
		}
	} elseif ( ! empty( $atts['exclude'] ) ) {
		$attachments = get_children( array( 'post_parent' => $id, 'exclude' => $atts['exclude'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
	} else {
		$attachments = get_children( array( 'post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) );
	}

	if ( empty( $attachments ) ) {
		return '';
	}

	if ( is_feed() ) {
		$output = "\n";
		foreach ( $attachments as $att_id => $attachment ) {
			$output .= wp_get_attachment_link( $att_id, $atts['size'], true ) . "\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 = intval( $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 ) ) {
		$gallery_style = "
		<style type='text/css'>
			#{$selector} {
				margin: auto;
			}
			#{$selector} .gallery-item {
				float: {$float};
				margin-top: 10px;
				text-align: center;
				width: {$itemwidth}%;
			}
			#{$selector} img {
				border: 2px solid

---

更新日志

Version	description
2.5.0	Introduced.

---

相关函数

Uses

• wp-includes/post.php: get_children()
• wp-includes/theme.php: current_theme_supports()
• wp-includes/formatting.php: tag_escape()
• wp-includes/formatting.php: sanitize_html_class()
• wp-includes/formatting.php: wptexturize()
• wp-includes/kses.php: wp_kses_allowed_html()
• wp-includes/query.php: is_feed()
• wp-includes/l10n.php: is_rtl()
• wp-includes/shortcodes.php: shortcode_atts()
• wp-includes/plugin.php: apply_filters()
• wp-includes/post-template.php: wp_get_attachment_link()
• wp-includes/media.php: post_gallery
• wp-includes/media.php: use_default_gallery_style
• wp-includes/media.php: gallery_style
• wp-includes/media.php: wp_get_attachment_image()
• wp-includes/post.php: wp_get_attachment_metadata()
• wp-includes/post.php: get_posts()
• wp-includes/post.php: get_post()
Show 13 more uses Hide more uses

---

User Contributed Notes

1. Skip to note content You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note Contributed by Codex

   Basic Example

   Adds the gallery shortcode.

   
   add_shortcode( 'gallery', 'gallery_shortcode' );