概要
wp_get_attachment_metadata関数は、指定された添付ファイルのメタ情報を取得するために使用されます。この関数は、主に添付ファイル（画像や動画など）の詳細な情報を取得する際によく使われます。具体的には以下のような機能を実装する際に利用されます。
- 画像のサイズや型を取得する。
- 添付ファイルのキャプションや説明文を表示する。
- メディアギャラリーのカスタマイズに使用する。
- サムネイルの生成を確認する。
- 動画や音声ファイルのメタデータを取得する。
- 添付ファイルのフィルタリングやソート処理に活用する。
- 데이터베이스에서 첨부파일의 커스터마이즈 관련 정보를 가져오는 데 사용된다.
- メディアの自動最適化やリサイズ処理を行う際に利用される。
構文
wp_get_attachment_metadata( $att_id, $context );
パラメータ
$att_id(int): 添付ファイルのID（必須）。$context(string): 使用されるコンテキスト（オプション）。
戻り値
- 添付ファイルのメタデータ（配列形式）。メタデータが存在しない場合は
falseを返す。
関連する関数
使用可能なバージョン
wp_get_attachment_metadata関数は、WordPress 2.5以降で利用可能です。
含まれるコアファイルのパス
wp-includes/post.php
この関数のアクションでの使用可能性
| アクション名 | 使用可能 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプルコード1: 添付ファイルのメタ情報を取得する
$attachment_id = 123; // 添付ファイルID
$metadata = wp_get_attachment_metadata( $attachment_id );
if ( $metadata ) {
echo '<pre>';
print_r( $metadata );
echo '</pre>';
}
このコードは、特定の添付ファイルのメタ情報を取得して表示します。
サンプルコード2: 画像の幅と高さを取得する
$attachment_id = 123; // 添付ファイルID
$metadata = wp_get_attachment_metadata( $attachment_id );
if ( $metadata && isset( $metadata['width'], $metadata['height'] ) ) {
echo 'Width: ' . $metadata['width'] . 'px, Height: ' . $metadata['height'] . 'px';
}
このコードは、特定の添付ファイルの画像の幅と高さを表示します。
サンプルコード3: メタデータが取得できない場合の対処
$attachment_id = 123; // 添付ファイルID
$metadata = wp_get_attachment_metadata( $attachment_id );
if ( ! $metadata ) {
echo 'メタデータが見つかりません。';
} else {
// メタデータを使用した処理
}
このコードは、メタデータが取得できない場合のエラーメッセージを表示します。
サンプルコード4: サムネイルサイズを確認する
$attachment_id = 123; // 添付ファイルID
$metadata = wp_get_attachment_metadata( $attachment_id );
if ( $metadata && isset( $metadata['sizes'] ) ) {
foreach ( $metadata['sizes'] as $size_name => $size_info ) {
echo 'サイズ名: ' . $size_name . ', 幅: ' . $size_info['width'] . ', 高さ: ' . $size_info['height'] . '<br>';
}
}
このコードは、添付ファイルのすべてのサイズに関する情報を表示します。
サンプルコード5: 添付ファイルの説明を表示する
$attachment_id = 123; // 添付ファイルID
$attachment = get_post( $attachment_id );
$metadata = wp_get_attachment_metadata( $attachment_id );
if ( $attachment ) {
echo 'タイトル: ' . $attachment->post_title . '<br>';
echo '説明: ' . $attachment->post_excerpt . '<br>';
echo 'メタデータ: <pre>' . print_r( $metadata, true ) . '</pre>';
}
このコードは、添付ファイルのタイトルと説明、およびメタデータを表示します。