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



お勧め

自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)

標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。