概要
wp_get_registered_image_subsizes関数は、WordPressにおいて画像のサブサイズ情報を取得するために使用される関数です。この関数の主な機能には以下のようなものがあります。
- 設定された画像のサブサイズを取得する
- 画像のレスポンシブ表示を設定するためのサポート
- カスタム投稿タイプでの画像サイズ管理
- サムネイルを含むメディアライブラリの表示調整
- プラグインやテーマによる独自の画像サイズの登録確認
- 管理画面での画像サイズ確認
- フロントエンドにおける画像表示最適化
- 開発者によるデバッグ作業の効率化
構文
$subsizes = wp_get_registered_image_subsizes();
パラメータ
この関数はパラメータを持ちません。
戻り値
この関数は、登録された画像のサブサイズの配列を返します。各サブサイズは、幅、高さ、トリミング情報などのプロパティを含む連想配列として表されます。
関連する関数
使用可能なバージョン
この関数は、WordPress 4.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: サブサイズの表示
このサンプルコードは、登録されたサブサイズの全情報を取得し、表示します。
$subsizes = wp_get_registered_image_subsizes();
foreach ($subsizes as $size) {
echo 'Size: ' . $size['name'] . ' - Width: ' . $size['width'] . ' - Height: ' . $size['height'] . '<br>';
}
サンプルコード2: 特定のサブサイズの確認
このコードは、特定のサブサイズ（例: ‘thumbnail’）が登録されているか確認し、その情報を表示します。
$subsizes = wp_get_registered_image_subsizes();
if (array_key_exists('thumbnail', $subsizes)) {
echo 'Thumbnail size exists with width: ' . $subsizes['thumbnail']['width'];
} else {
echo 'Thumbnail size does not exist.';
}
サンプルコード3: サブサイズの数を取得
このサンプルでは、登録されているサブサイズの数をカウントして表示します。
$subsizes = wp_get_registered_image_subsizes();
echo 'Registered image sub sizes count: ' . count($subsizes);
サンプルコード4: サブサイズの詳細情報を取得し、JSON形式で出力
このコードは、登録されたサブサイズの詳細情報をJSON形式で出力します。
$subsizes = wp_get_registered_image_subsizes();
echo json_encode($subsizes);
サンプルコード5: サブサイズの新規登録
このコードは、サブサイズを新たに登録し、すぐにその情報を取得して表示します。
add_action('after_setup_theme', function() {
add_image_size('custom-size', 300, 200, true);
});
$subsizes = wp_get_registered_image_subsizes();
echo 'Custom size added: ' . $subsizes['custom-size']['name'] ?? 'Not found';
これらのサンプルコードは、wp_get_registered_image_subsizes関数の基本的な使い方を示しており、開発の参考になるでしょう。