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

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

Contents

Parameters Parameters

$post

(int|WP_Post) (Optional) Post ID or WP_Post object. Default is global $post.

$html

(bool) (Optional) Whether to return HTML or data. Default is true.

Default value: true

Top ↑

Return Return

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

Top ↑

Source Source

File: wp-includes/media.php 

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.
	 * @param array       $galleries Associative array of all found post galleries.
	 */
	return apply_filters( 'get_post_gallery', $gallery, $post, $galleries );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/media.php: get_post_galleries()

Retrieves galleries from the passed post’s content.
wp-includes/media.php: get_post_gallery

Filters the first-found post gallery.

Top ↑

Changelog Changelog

Changelog
Version Description
3.6.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  2. Skip to note 2 content
    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
    Contributed by Codex —

    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;
?>

    Expand full source codeCollapse full source code

    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)

You must log in before being able to contribute a note or feedback.