检索附件的标题。

原型

wp_get_attachment_caption( int $post_id )

参数

$post_id (int) (Optional)  附件ID。默认值是全局$ post的ID。

返回值

(string|false)  失败时是假的。附件标题成功。

源文件

路径:wp-includes/post.php

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?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 );
}

...
?>

其他

英文文档:https://developer.wordpress.org/reference/functions/wp_get_attachment_caption/