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

最終更新 : 2018年04月13日 17:04



お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

Gutenberg、「More」の翻訳は「続きを読む」?(2018年8月15日 更新)

Gutenbergの新エディターを使用中、ボタン上にポインタを移動させると「続きを読む」と表示されるところが複数あった。なぜ、ここが「続きを読む」なのか疑問に思ったので、少し調べてみた。

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

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

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。