wp_get_attachment_caption() WP 1.0

Retrieves the caption for an attachment.

Hooks from function:

Return

String/false. False on failure. Attachment caption on success.

Usage

wp_get_attachment_caption( $post_id );

$post_id(int)

Attachment ID.
Default: ID of the global $post

Code of wp_get_attachment_caption: wp-includes/post.php ^{VER 4.9.8}

<?php
function wp_get_attachment_caption( $post_id = 0 ) {
	$post_id = (int) $post_id;
	if ( ! $post = get_post( $post_id ) ) {
		return false;
	}

	if ( 'attachment' !== $post->post_type ) {
		return false;
	}

	$caption = $post->post_excerpt;

	/**
	 * Filters the attachment caption.
	 *
	 * @since 4.6.0
	 *
	 * @param string $caption Caption for the given attachment.
	 * @param int    $post_id Attachment ID.
	 */
	return apply_filters( 'wp_get_attachment_caption', $caption, $post->ID );
}

Related Functions

From tag: caption (of image)

More from category: Images