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

説明

is_attachment() は、添付ファイル(メディア)の個別ページを表示しているかを判定する関数です。

基本構文

is_attachment( int|string|int[]|string[] $attachment = '' ): bool

引数

  • $attachment:ID・タイトル・スラッグ(省略可)

戻り値

条件に当てはまれば true、そうでなければ false。

使い方(サンプル)

if ( is_attachment() ) {
	// 添付ファイルページ
}

注意点

  • 画像などのメディアの個別ページが対象です。
  • 添付ファイルページは SEO 上不要な場合が多く、無効化するケースもあります。

実務での使いどころ

  • 添付ファイルのページで、表示を変えるとき。

よくあるミスと対処

  • 投稿の中に表示した画像を判定するつもりで使っている。対象は、添付ファイル専用のページ。
  • 添付ファイルのページを使っていないサイトで、判定しても意味がない。

NG例

if ( is_attachment() ) {
	// 記事内の画像を判定するつもり
}

OK例

if ( is_attachment() ) {
	echo wp_get_attachment_image( get_the_ID(), 'large' );
}

使い分け早見表

やりたいこと 使うもの
添付ファイルのページか is_attachment()
画像のURLを取得 wp_get_attachment_url()
画像のタグを出力 wp_get_attachment_image()

関連項目

is_single()、is_singular()、wp_get_attachment_url()

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

コメント

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