post_gallery filter-hookWP 2.5.0

Filters the default gallery shortcode output.

If the filtered output isn't empty, it will be used instead of generating the default gallery template.

Usage

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

/**
 * Function for `post_gallery` filter-hook.
 * 
 * @param string $output   The gallery output.
 * @param array  $attr     Attributes of the gallery shortcode.
 * @param int    $instance Unique numeric ID of this gallery shortcode instance.
 *
 * @return string
 */
function wp_kama_post_gallery_filter( $output, $attr, $instance ){

	// filter...
	return $output;
}
$output(string)
The gallery output.
Default: ''
$attr(array)
Attributes of the gallery shortcode.
$instance(int)
Unique numeric ID of this gallery shortcode instance.

Changelog

Since 2.5.0 Introduced.
Since 4.2.0 The $instance parameter was added.

Where the hook is called

gallery_shortcode()
post_gallery
wp-includes/media.php 2336
$output = apply_filters( 'post_gallery', '', $attr, $instance );

Where the hook is used in WordPress

Usage not found.