Plugin API/Filter Reference/post gallery

This page redirects to an external site: https://developer.wordpress.org/reference/hooks/post_gallery/

This page is marked as incomplete. You can help Codex by expanding it.

1 Description
2 Parameters
3 Examples
4 Triggers
5 Related

Description

Allows plugins and themes to override the default gallery template, ie. what the gallery shortcode returns.

Parameters

$output

(string) (required) The current output - the WordPress core passes an empty string.

Default: ""

$atts

(array) (required) The attributes from the gallery shortcode.

Default: None

$instance

(int) (required) Unique numeric ID of this gallery shortcode instance.

Default: None

Examples

Hook into the gallery shortcode and replace its output with your own.

function my_gallery_shortcode( $output = '', $atts = null, $instance = null ) {
	$return = $output; // fallback

	// retrieve content of your own gallery function
	$my_result = get_my_gallery_content( $atts );

	// boolean false = empty, see http://php.net/empty
	if( !empty( $my_result ) ) {
		$return = $my_result;
	}

	return $return;
}

add_filter( 'post_gallery', 'my_gallery_shortcode', 10, 3 );

Triggers

This function is applied once, in wp-includes/media.php - in gallery_shortcode() on line 1648

Codex