云策 WordPress 开发者社区

函数文档

the_post_thumbnail_caption()

查看官方原文 ↗
💡 云策文档标注

概述

the_post_thumbnail_caption() 是一个 WordPress 模板标签，用于在主题文件中直接输出文章特色图片的标题。它基于 get_the_post_thumbnail_caption() 获取标题，并通过过滤器允许开发者自定义输出内容。

关键要点

  • 函数用于显示文章特色图片的标题，直接输出到页面。
  • 接受一个可选参数 $post，可以是文章 ID、WP_Post 对象或 null（默认使用全局 $post）。
  • 内部使用 apply_filters() 应用 'the_post_thumbnail_caption' 过滤器，允许修改显示的标题字符串。
  • 首次引入于 WordPress 4.6.0 版本。

相关函数

  • get_the_post_thumbnail_caption()：返回文章特色图片的标题，但不直接输出。
  • apply_filters()：调用添加到过滤器钩子的回调函数。
📄 原文内容

Displays the post thumbnail caption.

Parameters

$postint|WP_Post|nulloptional
Post ID or WP_Post object. Default is global $post.

Default:null

Source

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 ) );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘the_post_thumbnail_caption’, string $caption )

Filters the displayed post thumbnail caption.

Uses Description
get_the_post_thumbnail_caption()wp-includes/post-thumbnail-template.php

Returns the post thumbnail caption.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Changelog

Version Description
4.6.0 Introduced.