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



お勧め

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

xmlrpc.phpへのアクセスについてちょっと考えた(2018年5月27日 更新)

少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。

メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 更新)

この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。