get_the_post_thumbnail_url

説明

string | bool get_the_post_thumbnail_url( [ int | WP_Post $post = null [ , string | int[] $size = 'post-thumbnail' ] ] )
アイキャッチ画像(サムネイル)のURLを取得する。

パラメータ

  • $post
    投稿情報のWP_Postオブジェクトか投稿IDを指定(省略時はnull)。
  • $size
    画像サイズを示す文字列か高さと幅を格納した配列を指定(省略時は'post-thumbnail')。

返り値

投稿に指定されたアイキャッチ画像のURLを返す。パラメータ$postが無効かアイキャッチ画像が指定されていない場合はfalseを返す。

注意

パラメータ$postが省略された場合は現在の投稿情報が対象となる。

[5.9.0]'post_thumbnail_url'フィルターが追加された。


使用例

  • 現在の投稿のアイキャッチ画像のURLを取得する。
    $url = get_the_post_thumbnail_url();
  • 変数$postのアイキャッチ画像のURLを取得する。
    $url = get_the_post_thumbnail_url( $post );

フィルター

[5.9.0]アイキャッチ画像のURLを返す前に'post_thumbnail_url'フィルターを呼び出す。パラメータ$thumbnail_urlにはアイキャッチ画像のURLが、$post$sizeには本関数が受け取った内容が格納されている。
return apply_filters( 'post_thumbnail_url', $thumbnail_url, $post, $size );

アクション

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

ソースファイル

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

最終更新 : 2022年02月01日 12:50



お勧め

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

投稿一覧ページに「更新日時」カラムを追加してみた(2019年8月27日 更新)

サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。

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

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

get_postsとquery_postsを使い分け(2018年5月27日 更新)

get_posts query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。