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



お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。