wp_get_attachment_thumb_url() の使い方|説明・引数・注意点

説明

wp_get_attachment_thumb_url() は、添付画像のサムネイルURLを返す関数です(非推奨)。

基本構文

wp_get_attachment_thumb_url( int $post_id = 0 ): string|false

引数

  • $post_id:添付ファイルのID

戻り値

サムネイルのURL。

使い方(サンプル)

// 代わりにこちらを使う
$img = wp_get_attachment_image_src( 45, 'thumbnail' );

注意点

  • 非推奨ではないが、サイズを選べない。wp_get_attachment_image_src() や wp_get_attachment_image_url() を使うのが、一般的。

実務での使いどころ

  • メディアの、サムネイルのURLを取得するとき。

よくあるミスと対処

  • サイズが thumbnail に固定される。別のサイズが欲しいときは、wp_get_attachment_image_src() を使う。
  • サムネイルがないときは、フルサイズのURLが返る。false になるのは、添付ファイルがないなど、URLを取得できないとき。

NG例

echo wp_get_attachment_thumb_url( $id ); // サイズを選べず、false のときも出力される

OK例

$src = wp_get_attachment_image_src( $id, 'medium' );
if ( $src ) {
	echo esc_url( $src[0] );
}

使い分け早見表

やりたいこと 使うもの
サムネイルのURL wp_get_attachment_thumb_url()
サイズを指定したURL wp_get_attachment_image_src()
元のファイルのURL wp_get_attachment_url()

関連項目

wp_get_attachment_image_src()

公式リファレンス:wp_get_attachment_thumb_url() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました