ワードプレスのwp_mime_type_iconフィルタの使用方法・解説

概要

wp_mime_type_iconフィルタは、MIMEタイプまたはメディアの投稿IDからアイコンURLを取得するために使用されるフィルタです。このフィルタを使うことで、特定のMIMEタイプに対して独自のアイコンを指定したり、特定のメディア投稿タイプに対して異なるアイコンを提供したりすることが可能になります。

このフィルタは、以下のような機能を実装する際によく使われます：
1. メディアライブラリ内のアイコン表示をカスタマイズ。
2. 特定のファイルタイプに対するアイコンを独自のものに変更。
3. インストールされているプラグインが生成するファイルタイプにアイコンを追加。
4. 画像や動画以外のファイルに適切なアイコンを設定。
5. 表示するアイコンのサイズを変更。
6. 特定の条件下で異なるアイコンを表示。
7. テーマに合わせたアイコンスタイルの提供。
8. メディアの種類に応じたブランドアイコンの活用。

構文

apply_filters( 'wp_mime_type_icon', $icon, $mime_type, $post_id );

パラメータ

• $icon (string): デフォルトのアイコンURL。
• $mime_type (string): MIMEタイプ。
• $post_id (int): メディア投稿のID。

戻り値

• (string) アイコンURL。

関連する関数

wp_mime_type_iconフィルタに関する関数

使用可能なバージョン

• WordPress 2.7 以降

ワードプレスのコアファイルのパス

• 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. デフォルトアイコンを変更するサンプル

   add_filter('wp_mime_type_icon', 'custom_mime_type_icon', 10, 3);
   function custom_mime_type_icon($icon, $mime_type, $post_id) {
      if ($mime_type === 'image/jpeg') {
          return 'path/to/your/custom/icon.png';
      }
      return $icon;
   }
   

   • 説明: JPEG画像のMIMEタイプにカスタムアイコンを設定します。

2. 特定の投稿IDのアイコンを変更するサンプル

   add_filter('wp_mime_type_icon', 'custom_icon_for_specific_post', 10, 3);
   function custom_icon_for_specific_post($icon, $mime_type, $post_id) {
      if ($post_id === 42) { // 投稿IDが42の時
          return 'path/to/another/icon.png';
      }
      return $icon;
   }
   

   • 説明: 特定の投稿ID（この場合42）に対して異なるアイコンを提供します。

3. 全ての音声ファイル用のアイコンを設定するサンプル

   add_filter('wp_mime_type_icon', 'audio_file_icon', 10, 3);
   function audio_file_icon($icon, $mime_type, $post_id) {
      if (strpos($mime_type, 'audio/') === 0) {
          return 'path/to/audio/icon.png';
      }
      return $icon;
   }
   

   • 説明: MIMEタイプが音声ファイルの場合、音声用アイコンを設定します。

4. カスタムMIMEタイプのアイコンを設定するサンプル

   add_filter('wp_mime_type_icon', 'custom_mime_icon', 10, 3);
   function custom_mime_icon($icon, $mime_type, $post_id) {
      if ($mime_type === 'application/pdf') {
          return 'path/to/pdf/icon.png';
      }
      return $icon;
   }
   

   • 説明: PDFファイルに対して自分のアイコンを設定する例です。

5. SVGファイル用のアイコンを設定するサンプル

   add_filter('wp_mime_type_icon', 'svg_icon', 10, 3);
   function svg_icon($icon, $mime_type, $post_id) {
      if ($mime_type === 'image/svg+xml') {
          return 'path/to/svg/icon.svg';
      }
      return $icon;
   }
   

   • 説明: SVG形式の画像ファイルに特有のアイコンを設定します。