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

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

関数リファレンス/wp read image metadata

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

この項目「関数リファレンス/wp read image metadata」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

画像ファイルの拡張メタデータ(付加されている EXIF または IPTC)を取得します。

EXIF メタデータは aperture (F ナンバー), credit (クレジット表示), camera (画像入力機器のモデル名), caption (画像タイトル), copyright (著作権者), iso (ISO 感度), created_timestamp (作成日時), focal_length (レンズ焦点距離), shutter_speed (露出時間), および title (タイトル) を取得します。

IPTC メタデータは APP13, credit, byline, created date and time, caption, copyright, および title を取得します。さらに FNumber, Model, DateTimeDigitized, FocalLength, ISOSpeedRatings, および ExposureTime も含まれます。

使い方

<?php wp_read_image_metadata( $file ); ?>

パラメータ

$file
string) (必須) 画像ファイルの絶対パス。
初期値: なし

戻り値

(真偽値|配列) 
失敗すると false を返します。成功すると画像のメタデータの配列を返します。

返される配列の要素は次のとおりです:

["aperture"] 
(文字列) EXIF の FNumber フィールドの値。
["credit"] 
(文字列) 下記のフィールドを順に見て最初の空ではない値:
  1. IPTC Credit フィールド (2#110)
  2. IPTC Creator フィールド (2#080)
  3. EXIF Artist フィールド (アーティスト)
  4. EXIF Author フィールド
["camera"] 
(文字列) EXIF の Model フィールドの値。
["caption"] 
(文字列) 下記のフィールドのうち空ではない値 (詳しい条件はソースコードをみてください):
  1. IPTC Description フィールド (2#120)
  2. EXIF UserComment フィールド (ユーザコメント) - ["title"] がセットされず かつ EXIF:ImageDescription が80文字未満
  3. EXIF ImageDescription フィールド (画像タイトル) - ["title"] がセットされている または EXIF:ImageDescription が80文字以上
  4. EXIF Comments フィールド - ["title"] が EXIF:Comments と異なる
["created_timestamp"] 
(文字列) 下記のフィールドを順に見て最初の空ではない値:
  1. EXIF DateTimeDigitized フィールド (デジタルデータの作成日時)
  2. IPTC Date および Time フィールド (2#055 と 2#060)
["copyright"] 
(文字列) 下記のフィールドを順に見て最初の空ではない値:
  1. IPTC Copyright フィールド (2#116)
  2. EXIF Copyright フィールド (撮影著作権者/編集著作権者)
["focal_length"] 
(文字列) EXIF の FocalLength フィールドの値。
["iso"] 
(文字列) EXIF の ISOSpeedRatings フィールドの値。
["shutter_speed"] 
(文字列) EXIF の ExposureTime フィールドの値。
["title"] 
(文字列) 下記のフィールドを順に見て最初の空ではない値:
  1. IPTC Headline フィールド (2#105)
  2. IPTC Title フィールド (2#005)
  3. IPTC Description フィールド (2#120) - 80文字未満の場合のみ
  4. EXIF Title フィールド
  5. EXIF ImageDescription フィールド (画像タイトル) - 80文字未満の場合のみ

参考: 上記の IPTC フィールドに続けて記載されている (2#nnn) は、PHP の関数 iptcparse が返す配列のキーで、その IPTC フィールドに対応します。

用例

参考

この関数を呼び出して次のようなエラーが発生した場合は:

PHP Fatal error: Uncaught Error: Call to undefined function wp_read_image_metadata() ...

ファイル wp-admin/includes/image.php をインクルードしてください:

<?php
require_once ABSPATH . '/wp-admin/includes/image.php';
 
$path = '/path/to/file.jpg';
 
wp_read_image_metadata( $path );
?>

変更履歴

新規導入 : 2.5

ソースファイル

wp_read_image_metadata()wp-admin/includes/image.php にあります。

関連項目

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


最新英語版: Reference / Functions / wp_read_image_metadata()