当前浏览:首页 / WordPress函数 / get_post_thumbnail_id()

get_post_thumbnail_id( int|WP_Post $post = null )

检索文章缩略图ID

idmore...

postmore...

thumbnail 缩略图


参数

$post

(int|WP_Post) (可选) Post ID或WP_Post对象。默认值为全局$post

默认值: null


返回

(int|false) 文章缩略图ID(如果未设置缩略图,则可以为0),如果文章不存在,则为false。


说明

  • 要启用特色图像,在当前主题的 functions.php 文件 中添加 add_theme_support( 'post-thumbnails' );,另见 文章缩略图
  • "文章缩略图"是"特殊图像"的一个过时的术语。这个函数返回文章的特色图片的ID。它不返回附在文章上的其他图片的ID。


源码

查看源码 官方文档


更新日志

版本描述
5.5.0不存在文章的返回值更改为false,而不是空字符串
4.4.0$post可以是post ID或WP_Post对象
2.9.0开始引入

使用示例

  • 示例1

    请注意,返回值通常是字符串,而不是整数(尚未看到函数返回整数)。

  • 示例2

    显示当前文章除特色图片外的所有附件
    要获取除特色图片外的所有文章附件,您可以将此函数与get_posts()之类的内容一起使用。

    在循环内执行此操作(其中$post->ID是可用的).

    $args = array(
    	'post_type'   => 'attachment',
    	'numberposts' => -1,
    	'post_status' => 'any',
    	'post_parent' => $post->ID,
    	'exclude'     => get_post_thumbnail_id(),
    );
    
    $attachments = get_posts( $args );
    
    if ( $attachments ) {
    	foreach ( $attachments as $attachment ) {
    		echo apply_filters( 'the_title', $attachment->post_title );
    		the_attachment_link( $attachment->ID, false );
    	}
    }
    
  • 示例3

    要设置文章缩略图,请使用set_post_thumbnail

    set_post_thumbnail( $post_id, $thumbnail_id );