• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp get attachment metadata

提供: WordPress Codex 日本語版
移動先: 案内検索

添付ファイルの ID を指定して、そのメタデータを取得します。

使い方

<?php wp_get_attachment_metadata( $attachment_id, $unfiltered ); ?>

パラメータ

$attachment_id
整数) (必須) 添付ファイルの ID
初期値: なし
$unfiltered
真偽値) (オプションtrue を指定するとフィルターを適用しません。
初期値: false

戻り値

(配列|真偽値) 
添付ファイルのメタデータ。失敗すると false を返します。

メタデータには下記のフィールドが含まれます:

width 
(整数) 添付ファイルの幅
height 
(整数) 添付ファイルの高さ
file 
(文字列) wp-content/uploads/ を基点とする、ファイルの相対パス
sizes 
(配列) サイズ違いのファイルを表す配列。キーがサイズのスラッグで、値は次の 4 項目を持つ配列。'file', 'width', 'height', 'mime-type'(ファイル名、幅、高さ、MIMEタイプ)
image_meta 
(配列) 上記以外のメタデータの配列。

用例

戻り値の一例を示します。

   Array
   (
       [width] => 2400
       [height] => 1559
       [file] => 2011/12/press_image.jpg
       [sizes] => Array
           (
               [thumbnail] => Array
                   (
                       [file] => press_image-150x150.jpg
                       [width] => 150
                       [height] => 150
                       [mime-type] => image/jpeg
                   )
               [medium] => Array
                   (
                       [file] => press_image-4-300x194.jpg
                       [width] => 300
                       [height] => 194
                       [mime-type] => image/jpeg
                   )
               [large] => Array
                   (
                       [file] => press_image-1024x665.jpg
                       [width] => 1024
                       [height] => 665
                       [mime-type] => image/jpeg
                   )
               [post-thumbnail] => Array
                   (
                       [file] => press_image-624x405.jpg
                       [width] => 624
                       [height] => 405
                       [mime-type] => image/jpeg
                   )
           )
       [image_meta] => Array
           (
               [aperture] => 5
               [credit] => 
               [camera] => Canon EOS-1Ds Mark III
               [caption] => 
               [created_timestamp] => 1323190643
               [copyright] => 
               [focal_length] => 35
               [iso] => 800
               [shutter_speed] => 0.016666666666667
               [title] => 
           )
   )

参考

  • apply_filters( 'wp_get_attachment_metadata', メタデータの配列, 添付ファイルの ID );
$unfiltered が true で無ければ、フィルターを適用します。

変更履歴

バージョン 2.1.0 : 新規導入。

ソースファイル

wp_get_attachment_metadata()wp-includes/post.php にあります。

添付ファイル関数: get_children(), get attached media(), the_attachment_link(), get_attachment_link(), wp_get_attachment_link(), wp_get_attachment_image(), wp_get_attachment_image_src(), wp_get_attachment_url(), wp_get_attachment_thumb_file(), wp_get_attachment_thumb_url(), is_attachment(), wp_get_attachment_metadata()



関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_get_attachment_metadata最新版との差分