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

概要

wp_image_editor_supportsフィルタは、WordPressのイメージエディタが特定の機能をサポートしているかどうかを確認する際に使用されます。主に以下のような機能の実装時に活用されます。

1. 画像のリサイズ
2. 画像のトリミング
3. 画像の回転
4. フィルターの適用
5. サムネイルの生成
6. 画像の上下反転
7. 画像の明るさ調整
8. 画像フォーマットの変換

構文

add_filter('wp_image_editor_supports', 'custom_image_editor_support', 10, 2);

パラメータ

1. $supports (array): イメージエディタがサポートしている機能の配列
2. $mime_type (string): 画像のMIMEタイプ

戻り値

• サポートする機能を含む配列を返します。

関連する関数

• wp_image_editor_supports

使用可能なバージョン

• WordPress 3.5 以降

コアファイルのパス

• wp-includes/class-wp-image-editor.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_image_editor_supports', function($supports, $mime_type) {
      if ($mime_type === 'image/jpeg') {
          $supports[] = 'resize';
      }
      return $supports;
   });
   

   説明: JPEG 画像に対してリサイズ機能を追加します。

2. トリミング機能の追加

   add_filter('wp_image_editor_supports', function($supports, $mime_type) {
      if ($mime_type === 'image/png') {
          $supports[] = 'crop';
      }
      return $supports;
   });
   

   説明: PNG 画像にトリミング機能を追加します。

3. 回転機能の有効化

   add_filter('wp_image_editor_supports', function($supports, $mime_type) {
      $supports[] = 'rotate';
      return $supports;
   });
   

   説明: すべての画像に回転機能を提供します。

4. フィルター適用のサポート追加

   add_filter('wp_image_editor_supports', function($supports) {
      $supports[] = 'filters';
      return $supports;
   });
   

   説明: すべての画像にフィルターを適用する機能をサポートします。

5. 画像フォーマット変換機能の追加

   add_filter('wp_image_editor_supports', function($supports, $mime_type) {
      if ($mime_type === 'image/gif') {
          $supports[] = 'convert';
      }
      return $supports;
   });
   

   説明: GIF 画像にフォーマット変換機能を追加します。