the_post_thumbnail_caption() WordPress Function

The the_post_thumbnail_caption() function displays the caption for an image uploaded to a post or page. This function should be used within The Loop.

the_post_thumbnail_caption( int|WP_Post $post = null ) #

Displays the post thumbnail caption.


Parameters

$post

(int|WP_Post)(Optional) Post ID or WP_Post object. Default is global $post.

Default value: null


Top ↑

Source

File: wp-includes/post-thumbnail-template.php

function the_post_thumbnail_caption( $post = null ) {
	/**
	 * Filters the displayed post thumbnail caption.
	 *
	 * @since 4.6.0
	 *
	 * @param string $caption Caption for the given attachment.
	 */
	echo apply_filters( 'the_post_thumbnail_caption', get_the_post_thumbnail_caption( $post ) );
}


Top ↑

Changelog

Changelog
VersionDescription
4.6.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.