ワードプレスのget_intermediate_image_sizes関数の使用方法・解説

概要

get_intermediate_image_sizes関数は、WordPressでの画像処理に関する強力な機能を提供します。この関数は、利用可能な画像のサイズ名を取得するために使用されます。具体的には、WordPressが生成する各種中間画像サイズを取得し、テーマやプラグインのカスタマイズで使うことができます。この関数は、以下のような機能を実装する際によく使われます。

1. 画像表示の最適化
2. レスポンシブデザイン対応の画像挿入
3. カスタム画像サイズの管理
4. 特定の画像サイズに基づく条件分岐
5. ギャラリーの画像サイズ指定
6. メディアライブラリの表示調整
7. サムネイルの一括生成
8. カスタムテンプレートでの画像呼び出し

構文

get_intermediate_image_sizes();

パラメータ

この関数はパラメータを持ちません。

戻り値

戻り値は、登録された中間画像サイズの名前を含む配列です。

関連する関数

• add_image_size
• get_image_size
• wp_get_attachment_metadata

使用可能なバージョン

この関数はWordPress 2.9.0以降で利用可能です。

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

wp-includes/media.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. 全ての中間画像サイズを取得する

   $image_sizes = get_intermediate_image_sizes();
   print_r($image_sizes);
   

   このコードは、全ての登録された中間画像サイズの配列を取得し、画面に出力します。

2. 特定の画像サイズが存在するか確認する

   if (in_array('medium', get_intermediate_image_sizes())) {
      echo 'Medium size is available.';
   }
   

   このコードは、’medium’ サイズが登録されているかどうかを確認し、存在する場合にはメッセージを表示します。

3. カスタム画像サイズを取得して表示する

   $sizes = get_intermediate_image_sizes();
   foreach ($sizes as $size) {
      echo '<p>' . esc_html($size) . '</p>';
   }
   

   このコードは、利用可能な全ての中間画像サイズをループで回し、各サイズの名前をHTMLの段落として出力します。

4. 特定の画像サイズに基づく処理

   $image_sizes = get_intermediate_image_sizes();
   if (in_array('large', $image_sizes)) {
      // 大きな画像サイズ処理
   }
   

   このコードは、’large’ サイズが利用可能な場合に、大きな画像サイズに関連する処理を実行します。

5. カスタムサイズ定義後の画像サイズ確認

   add_image_size('custom-size', 800, 600, true);
   $sizes = get_intermediate_image_sizes();
   print_r($sizes);
   

   このコードは、’custom-size’というカスタム画像サイズを追加した後、全ての中間画像サイズを確認し出力します。