概要
wp_attachment_is_image関数は、メディア投稿（attachment）の添付ファイルが画像ファイルかどうかを調べる際に使用される関数です。この関数を使用することで、画像とも言えないファイルを簡単にフィルタリングしたり、アプリケーションの動作を変更したりすることができます。
よく使われる具体的な機能には以下のようなものがあります。
1. メディアライブラリでの画像の表示フィルタリング
2. 画像に対する追加の処理やバリデーション
3. 投稿のメディアメタ情報を取得した後に、画像ファイルの判定
4. ギャラリーやスライダーの自動生成時の画像ファイル管理
5. 画像と動画の処理を分けるための条件分岐
6. サムネイルの生成時に画像ファイルかどうかを確認
7. 不正なファイルアップロード防止のためのチェック
8. 画像のカスタムタイプのカスタマイズ
構文
wp_attachment_is_image( $attachment_id );
パラメータ
$attachment_id(int) (必須): 添付ファイルのID。
戻り値
- (bool): 添付ファイルが画像の場合は
true、それ以外の場合はfalse。
関連する関数
使用可能なバージョン
- WordPress 2.5.0以降
コアファイルのパス
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は適切な添付ファイルのIDに置き換えてください
if ( wp_attachment_is_image( $attachment_id ) ) {
echo 'この添付ファイルは画像です。';
} else {
echo 'この添付ファイルは画像ではありません。';
}
このコードは、指定した添付ファイルのIDが画像かどうかを検査し、その結果を表示します。
サンプル2: メディアライブラリで画像のみを取得
$query_args = array(
'post_type' => 'attachment',
'post_mime_type' => 'image',
);
$images = new WP_Query( $query_args );
このコードは、メディアライブラリから画像のみに限定して取得します。
サンプル3: 画像と非画像のカスタム処理
function my_custom_attachment_filter( $attachment_id ) {
if ( wp_attachment_is_image( $attachment_id ) ) {
// 画像に対する処理
} else {
// 非画像に対する処理
}
}
add_action( 'wp_insert_attachment', 'my_custom_attachment_filter' );
このコードは、添付ファイルが保存される際に、画像か非画像かを判別して異なる処理を実行します。
サンプル4: ファイルアップロード前に画像を確認
function validate_attachment( $post_id ) {
if ( ! wp_attachment_is_image( $post_id ) ) {
wp_delete_attachment( $post_id );
wp_die( '画像のみアップロードできます。' );
}
}
add_action( 'add_attachment', 'validate_attachment' );
このコードは、新しい添付ファイルが追加された際に、画像でない場合はそのファイルを削除します。
サンプル5: ギャラリー内で画像のみを一覧表示
$gallery_ids = array( 1, 2, 3, 4, 5 );
foreach ( $gallery_ids as $id ) {
if ( wp_attachment_is_image( $id ) ) {
echo wp_get_attachment_link( $id );
}
}
このコードは、指定されたIDの配列から、画像のみをリンクとして表示します。