2024年07月01日

WP関数:get_the_post_thumbnail()


この関数の説明

WP関数の get_the_post_thumbnail() は、指定した投稿IDに設定されているアイキャッチ画像(サムネール)のデータを取得します。

※エスケープ処理された<img>タグが取得できます。

 


関数

get_the_post_thumbnail( $post_id, $size, $attr )

 


パラメータ

$post_id(整数)(オプション)

投稿 IDを指定します。

省略した場合は、現在の投稿になります。

 

$size(文字列 | 配列)(オプション)

表示する画像サイズを指定します。

省略した場合は set_post_thumbnail_size() で指定したサイズ

・キーワード指定場合

'thumbnail', 'medium', 'large', 'full'

・直接指定(幅、高さ)する場合

array( 150, 150 )

 

$attr配列)(オプション

アイキャッチ画像を<img>タグで表示する時の属性/値を配列で記述します。

利用方法は the_post_thumbnail() を参照してください。

 


戻り値

エスケープ処理された<img>タグが戻ります。

アイキャッチ画像が設定されてない場合はnullが返されます。

 


利用事例

①アイキャッチ画像(サムネール)が設定されていた場合は表示します。

<?php
	$thumbnail = get_the_post_thumbnail(get_the_ID() , array( 300, 300 )); 
	if( $thumbnail !== null){
		echo $thumbnail;
	}
?>

■2行目:サムネールをサイズ指定で取得しています。

■3行目:サムネールが設定されているか否かを判定しています。

■4行目:サムネールがあった場合は表示しています。

 


関連情報

関連関数は アイキャッチ関連関数 を参照してください.

 


関数一覧
  • 1.WPのエスケープ処理
  • 2.WPプログラムの基本
  • 3.ヘッダ/フッタ/サイドバで使われる関数
  • 4.DBからの読込関数
  • 5.一般テンプレートの中で使われる関数
  • 6.その他のWP関数
  • add_shortcode()
  • bloginfo()
  • body_class()
  • date_i18n()
  • dynamic_sidebar()
  • edit_post_link()
  • esc_attr()
  • esc_html_e()
  • esc_html()
  • esc_url()
  • get_ancestors()
  • get_cat_ID()
  • get_cat_name()
  • get_category_link()
  • get_category_parents()
  • get_category()
  • get_footer()
  • get_header()
  • get_home_url()
  • get_post_format()
  • get_post_meta()
  • get_post_thumbnail_id()
  • get_query_var()
  • get_search_query()
  • get_sidebar()
  • get_site_url()
  • get_stylesheet_directory_uri()
  • get_stylesheet_uri()
  • get_template_directory_uri()
  • get_template_part()
  • get_the_category()
  • get_the_content()
  • get_the_date()
  • get_the_excerpt()
  • get_the_ID()
  • get_the_modified_date()
  • get_the_modified_time()
  • get_the_permalink()
  • get_the_post_thumbnail()
  • get_the_tags()
  • get_the_time()
  • get_the_title()
  • get_uploaded_header_images()
  • get_year_link()
  • has_category()
  • has_custom_logo()
  • has_header_image()
  • has_header_video()
  • has_nav_menu()
  • has_post_thumbnail()
  • has_tag()
  • header_image()
  • home_url()
  • is_admin()
  • is_category()
  • is_date()
  • is_front_page()
  • is_home()
  • is_main_query()
  • is_page()
  • is_search()
  • is_single()
  • language_attributes()
  • the_category()
  • the_content()
  • the_custom_header_markup()
  • the_custom_logo()
  • the_date()
  • the_excerpt()
  • the_ID()
  • the_modified_date()
  • the_modified_time()
  • the_permalink()
  • the_post_thumbnail()
  • the_search_query()
  • the_tags()
  • the_time()
  • the_title()
  • update_post_meta()
  • wp_get_attachment_image_src()
  • wp_nav_menu()
  • WP_Query()