函数文档

the_post_thumbnail_url()

💡 云策文档标注

概述

the_post_thumbnail_url() 是一个 WordPress 函数,用于输出文章特色图片的 URL。它基于 get_the_post_thumbnail_url() 获取 URL 并自动进行安全转义。

关键要点

  • 函数用于直接输出文章特色图片的 URL,适用于在模板中嵌入图片链接。
  • 接受一个可选参数 $size,指定图片尺寸,可以是字符串(如 'post-thumbnail')或像素数组 [width, height],默认值为 'post-thumbnail'。
  • 内部调用 get_the_post_thumbnail_url() 获取 URL,并使用 esc_url() 进行转义以确保安全性。
  • 首次引入于 WordPress 4.4.0 版本。

代码示例

function the_post_thumbnail_url( $size = 'post-thumbnail' ) {
    $url = get_the_post_thumbnail_url( null, $size );

    if ( $url ) {
        echo esc_url( $url );
    }
}

注意事项

  • 此函数直接输出 URL,不返回任何值,因此适用于 echo 场景。
  • 如果不需要输出而需要获取 URL 值,应使用 get_the_post_thumbnail_url()。
  • 确保在模板中正确使用,以避免 XSS 攻击,esc_url() 已自动处理转义。

📄 原文内容

Displays the post thumbnail URL.

Parameters

$sizestring|int[]optional
Image size to use. Accepts any valid image size, or an array of width and height values in pixels (in that order).
Default 'post-thumbnail'.

Source

function the_post_thumbnail_url( $size = 'post-thumbnail' ) {
	$url = get_the_post_thumbnail_url( null, $size );

	if ( $url ) {
		echo esc_url( $url );
	}
}

Changelog

Version Description
4.4.0 Introduced.

User Contributed Notes