get_post_gallery() – Function | Developer.WordPress.org

Checks a specified post’s content for gallery and, if present, return the first

Parameters

$postint|WP_Postoptional: Post ID or WP_Post object. Default is global $post.
$htmlbooloptional: Whether to return HTML or data. Default is true.
Default:true

Return

string|array Gallery data and srcs parsed from the expanded shortcode.

Source

 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
 * @param bool        $html Optional. Whether to return HTML or data. Default is true.
 * @return string|array Gallery data and srcs parsed from the expanded shortcode.
 */
function get_post_gallery( $post = 0, $html = true ) {
	$galleries = get_post_galleries( $post, $html );
	$gallery   = reset( $galleries );

	/**
	 * Filters the first-found post gallery.
	 *
	 * @since 3.6.0
	 *
	 * @param array       $gallery   The first-found post gallery.
	 * @param int|WP_Post $post      Post ID or object.

View all references View on Trac View on GitHub

Changelog

Version	Description
3.6.0	Introduced.

User Contributed Notes

Skip to note 3 content

julien731 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

If there is no gallery present in the page, the function will return false (boolean).

Log in to add feedback

Codex 9 years ago

Example
Output each image in a gallery with our own custom image class when using data output and not HTML:

<?php
/* The loop */
while ( have_posts() ) : the_post();
	if ( $gallery = get_post_gallery( get_the_ID(), false ) ) :
		// Loop through all the image and output them one by one.
		foreach ( $gallery['src'] AS $src ) {
	                ?>                
	                <img src="<?php echo $src; ?>" class="my-custom-class" alt="Gallery image" />
			<?php
		}
	endif;
endwhile;
?>

Example data output

array (size=3)
  'link' => string 'file' (length=4)
  'ids' => string '423,424,425,426' (length=15)
  'src' => 
    array (size=4)
      0 => string 'http://www.yoursite.com/wp-content/uploads/2013/10/1296136694836-150x150.jpg' (length=85)
      1 => string 'http://www.yoursite.com/wp-content/uploads/2013/10/1315981706292-150x150.jpg' (length=85)
      2 => string 'http://www.yoursite.com/wp-content/uploads/2013/10/fate-stay-night-446-wall1200-150x150.jpg' (length=100)
      3 => string 'http://www.yoursite.com/wp-content/uploads/2013/10/GpTq3-150x150.jpg' (length=77)

get_post_gallery( int|WP_Post $post, bool $html = true ): string|array

In this article

Parameters

Return

Source

Changelog

User Contributed Notes