apply_filters( ‘post_gallery’, string $output, array $attr, int $instance )

Filters the default gallery shortcode output.


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

See also


The gallery output. Default empty.
Attributes of the gallery shortcode.
Unique numeric ID of this gallery shortcode instance.

More Information

This filter allows plugins and themes to override the default gallery template (i.e. what the gallery shortcode returns).


$output = apply_filters( 'post_gallery', '', $attr, $instance );


4.2.0The $instance parameter was added.

User Contributed Notes

  1. Skip to note 2 content

    Example Migrated from Codex:

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

    add_filter( 'post_gallery', 'my_gallery_shortcode', 10, 3 );
    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
    	if( !empty( $my_result ) ) {
    		$return = $my_result;
    	return $return;

You must log in before being able to contribute a note or feedback.