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

Parameters

$postint|WP_Post

Post ID or object.

$htmlbooloptional

Whether to return HTML or data in the array. Default true.Default: true

Return

array

A list of arrays, each containing gallery data and srcs parsed from the expanded shortcode.

Hooks fired · 1

One hook fires while get_post_galleries() runs, in this order:

1. 1
   apply_filters( get_post_galleries )filterline 5354 (+146 into the body)

   Filters the list of all found galleries in the given post.

Uses · 10

• get_post()Retrieves post data given a post ID or post object.
• has_shortcode()Determines whether the passed content contains the specified shortcode.
• has_block()Determines whether a $post or a string contains a specific block type.
• get_shortcode_regex()Retrieves the shortcode regular expression for searching.
• shortcode_parse_atts()Retrieves all attributes from the shortcodes tag.
• do_shortcode_tag()Regular Expression callable for do_shortcode() for calling shortcode hook.
• parse_blocks()Parses blocks out of a content string.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 5

• Twenty_Fourteen_Ephemera_Widget::widget()Output the HTML for this widget.
• get_post_galleries_images()Retrieves the image srcs from galleries from a post's content, if present.
• get_post_gallery()Checks a specified post's content for gallery and, if present, return the first
• twentyeleven_get_gallery_images()Retrieve the IDs for images in a gallery.
• twentyten_get_gallery_images()Retrieve the IDs for images in a gallery.

Source

View on Trac ↗View on GitHub ↗

5208function get_post_galleries( $post, $html = true ) {5209	$post = get_post( $post );5210 5211	if ( ! $post ) {5212		return array();5213	}5214 5215	if ( ! has_shortcode( $post->post_content, 'gallery' ) && ! has_block( 'gallery', $post->post_content ) ) {5216		return array();5217	}5218 5219	$galleries = array();5220	if ( preg_match_all( '/' . get_shortcode_regex() . '/s', $post->post_content, $matches, PREG_SET_ORDER ) ) {5221		foreach ( $matches as $shortcode ) {5222			if ( 'gallery' === $shortcode[2] ) {5223				$srcs = array();5224 5225				$shortcode_attrs = shortcode_parse_atts( $shortcode[3] );5226 5227				// Specify the post ID of the gallery we're viewing if the shortcode doesn't reference another post already.5228				if ( ! isset( $shortcode_attrs['id'] ) ) {5229					$shortcode[3] .= ' id="' . (int) $post->ID . '"';5230				}5231 5232				$gallery = do_shortcode_tag( $shortcode );5233				if ( $html ) {5234					$galleries[] = $gallery;5235				} else {5236					preg_match_all( '#src=([\'"])(.+?)\1#is', $gallery, $src, PREG_SET_ORDER );5237					if ( ! empty( $src ) ) {5238						foreach ( $src as $s ) {5239							$srcs[] = $s[2];5240						}5241					}5242 5243					$galleries[] = array_merge(5244						$shortcode_attrs,5245						array(5246							'src' => array_values( array_unique( $srcs ) ),5247						)5248					);5249				}5250			}5251		}5252	}5253 5254	if ( has_block( 'gallery', $post->post_content ) ) {5255		$post_blocks = parse_blocks( $post->post_content );5256 5257		while ( $block = array_shift( $post_blocks ) ) {5258			$has_inner_blocks = ! empty( $block['innerBlocks'] );5259 5260			// Skip blocks with no blockName and no innerHTML.5261			if ( ! $block['blockName'] ) {5262				continue;5263			}5264 5265			// Skip non-Gallery blocks.5266			if ( 'core/gallery' !== $block['blockName'] ) {5267				// Move inner blocks into the root array before skipping.5268				if ( $has_inner_blocks ) {5269					array_push( $post_blocks, ...$block['innerBlocks'] );5270				}5271				continue;5272			}5273 5274			// New Gallery block format as HTML.5275			if ( $has_inner_blocks && $html ) {5276				$block_html  = wp_list_pluck( $block['innerBlocks'], 'innerHTML' );5277				$galleries[] = '<figure>' . implode( ' ', $block_html ) . '</figure>';5278				continue;5279			}5280 5281			$srcs = array();5282 5283			// New Gallery block format as an array.5284			if ( $has_inner_blocks ) {5285				$attrs = wp_list_pluck( $block['innerBlocks'], 'attrs' );5286				$ids   = wp_list_pluck( $attrs, 'id' );5287

History

Introduced in 3.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/media.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.