Question

wp_get_attachment_caption( int $post_id )

Retrieves the caption for an attachment.

---

description

---

参数

$post_id

(int) (Optional) Attachment ID. Default is the ID of the global $post.

---

返回值

(string|false) False on failure. Attachment caption on success.

---

源代码

File: wp-includes/post.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 );
}

---

更新日志

Version	description
4.6.0	Introduced.

---

相关函数

Uses

• wp-includes/post.php: wp_get_attachment_caption
• wp-includes/plugin.php: apply_filters()
• wp-includes/post.php: get_post()

---

Used By

• wp-includes/post-thumbnail-template.php: get_the_post_thumbnail_caption()

---

User Contributed Notes