記事にアイキャッチ画像がある場合は、アイキャッチ画像を含むimg要素を返します。
get_the_post_thumbnail($post,$size,$attr);このテンプレートタグは実行時に引数を1つ渡すことができます。
| 引数 | 必須/任意 | 引数に指定する内容 |
|---|---|---|
第1引数$post | 任意 | 記事のID(整数) / オブジェクト初期値: null (現在の記事を指定します) |
第2引数$size | 任意 | 画像サイズを下記から指定。thumbnail(設定→メディアのサムネイルサイズ)medium(設定→メディアの中サイズ)medium_large(横幅768px)large(設定→メディアの大サイズ)full(オリジナルサイズ)初期値: post-thumbnail(テーマ次第)あるいは配列での指定も可能。 例: [500,300](横500px、縦300pxに収める) |
第3引数$attr | 任意 | 出力するimgタグに属性を追加する。文字列か配列で指定。例: ['class' => 'post_img', 'alt' => 'サムネイル画像'] |
戻り値(返す値):アイキャッチ画像を含むHTML(img要素)
※表示するにはechoします。
$thumbnail = get_the_post_thumbnail('full');<?php $thumbnail = get_the_post_thumbnail('', 'thumbnail', ['class' => 'post_img', 'alt' => 'サムネイル画像']); ?>【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。
【引数について】
※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。