wp_get_attachment_metadata

（2.1.0以降）
wp_get_attachment_metadata - 添付ファイルのメタ情報を取得する

説明

mixed wp_get_attachment_metadata( [ int $post_id = 0 [ , bool $unfiltered = false ] ] )
添付ファイルのメタ情報を取得する。

パラメータ

  • $post_id
    添付ファイルの投稿IDを指定（省略時は0）。
  • $unfiltered
    フィルター処理を行わない場合はtrue、行う場合はfalseを指定（省略時はfalse）。

返り値

添付ファイルのメタ情報（連想配列）を返す。パラメータ$post_idが無効な場合はfalseを返す。メタ情報（連想配列）の内容は次の通り。
キー名型値
widthstring幅（ピクセル）
heightstring高さ（ピクセル）
hwstring_smallstring幅と高さの属性値（例："height='96' width='115'"）
filestringファイルパス名（アップロードディレクトリからの相対パス）
sizesArray他サイズのイメージ情報の連想配列。キー名はthumbnailやmediumなどで、その値は連想配列（キー名はfile、width、height）となる（注：このfileの値はディレクトリを含まないファイル名のみ）。
image_metaArrayイメージのメタ情報の連想配列。3.3.1のキー名は、aperture、credit、camera、caption、created_timestamp、copyright、focal_length、iso、shutter_speed、titleである。

注意

添付ファイルのメタ情報は、'_wp_attachment_metadata'という名前のカスタムフィールドに格納されており、 get_post_meta関数で取得できる。

使用例

  • IDが10の添付ファイルのメタ情報を取得する。
    <?php $meta = wp_get_attachment_metadata( 10 ); ?>

フィルター

パラメータ$unfilteredがfalseの場合は、パス名を返す前にwp_get_attachment_metadataフィルターが呼び出される。フィルター関数に渡る$dataには生のメタ情報が、$attachment_idには添付ファイルの投稿IDを格納されている。
return apply_filters( 'wp_get_attachment_metadata', $data, $attachment_id )

アクション

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

ソースファイル

/wp-includes/post.php

最終更新 : 2019年11月19日 12:15

関連

参考

Code Reference: wp_get_attachment_metadata

お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

管理画面の'アイキャッチ画像'を'写真'に変える（2013年1月23日 更新）

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

5.7の機能拡張：投稿一覧画面向けのフィルター（2021年2月18日 更新）

昨日、予定通り公開された「WordPress 5.7 Beta 3（以降Beta 3）」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

タイトルのみをキーワード検索する（2014年4月3日 更新）

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。