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

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

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

Return

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

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 );
}

Changelog

Version Description
3.6.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_post_gallery