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



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。