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



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。