has_post_thumbnail

説明

bool has_post_thumbnail( [ int $post_id = null ] )
投稿記事にアイキャッチ画像が指定されているか調べる。

パラメータ

  • $post_id
    投稿記事のIDを指定(省略時はnull)。

返り値

投稿記事にアイキャッチ画像が指定されている場合はtrue、指定されていない場合はfalseを返す。

注意

パラメータ$post_idが省略された場合は、現在の投稿記事のアイキャッチ画像を調べ、その結果を返している。機能としては get_post_thumbnail_id関数とほぼ同じで、アイキャッチ画像のIDをそのまま返すか、IDの有無を返すかが違っている。
なお、以下に示す add_theme_support関数にてテーマがアイキャッチ画像をサポートしていないと本関数を含めアイキャッチ画像関連関数は未定義となるので、注意が必要である。

add_theme_support( 'post-thumbnails' );

[5.1.0]'has_post_thumbnail'フィルターが追加された。


使用例

  • 現在の投稿記事にアイキャッチ画像が指定されているか調べる。
    <?php if ( has_post_thumbnail() ) : ?>
  • IDが10の投稿記事にアイキャッチ画像が指定されているか調べる。
    <?php if ( has_post_thumbnail( 10 ) ) : ?>

フィルター

[5.1.0]結果を返す前に'has_post_thumbnail'フィルターを呼び出す。パラメータ$has_thumbnailには結果が、$postには対象の投稿情報が、$thumbnail_idにはアイキャッチ画像情報のIDが格納されている。
return (bool) apply_filters( 'has_post_thumbnail', $has_thumbnail, $post, $thumbnail_id );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/post-thumbnail-template.php

最終更新 : 2019年03月04日 12:56



お勧め

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

ツイート引用が簡単になる仕組み(2012年6月8日 更新)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

サイトヘルス機能を使ってみた(2019年4月12日 更新)

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。