wordpress / latest / functions / get_post_gallery.html

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

Checks 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: true

Return

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

Source

File: wp-includes/media.php. View all references

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

Hooks

Uses

Uses Description

Used By

Used By Description

Changelog

Version Description
3.6.0 Introduced.

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