wp_get_registered_image_subsizes()


WordPress関数wp_get_registered_image_subsizes()は、登録されている画像サイズを取得するために使用されます。この関数は、サイトで使用可能なすべての画像サイズの情報を配列形式で返します。

構文

wp_get_registered_image_subsizes();

例 1: 登録されているすべての画像サイズを取得する

このコードは、サイトに登録されているすべての画像サイズを配列として取得します。

<?php 
$sizes = wp_get_registered_image_subsizes();
print_r( $sizes );
?>

例 2: 特定の画像サイズを確認する

以下のコードは、特定の画像サイズが登録されているかどうかを確認します。

<?php 
$sizes = wp_get_registered_image_subsizes();
if ( isset( $sizes['thumbnail'] ) ) {
    echo 'サムネイルサイズが登録されています。';
}
?>

例 3: カスタム画像サイズを登録して確認する

カスタム画像サイズを登録し、それが正しく取得されているか確認します。

<?php 
add_image_size( 'custom-size', 800, 600 );
$sizes = wp_get_registered_image_subsizes();
if ( isset( $sizes['custom-size'] ) ) {
    echo 'カスタムサイズが登録されています。';
}
?>

例 4: 最大幅を持つ画像サイズを取得する

登録されている画像サイズの中から最大幅を持つものを探します。

<?php 
$sizes = wp_get_registered_image_subsizes();
$max_width = 0;
foreach ( $sizes as $size => $details ) {
    if ( $details['width'] > $max_width ) {
        $max_width = $details['width'];
        $largest_size = $size;
    }
}
echo '最大幅の画像サイズ: ' . $largest_size;
?>

例 5: JSON形式で画像サイズ情報を返す

登録されている画像サイズ情報をJSON形式で出力します。

<?php 
$sizes = wp_get_registered_image_subsizes();
echo json_encode( $sizes );
?>

注意点

  • wp_get_registered_image_subsizes()は、WordPress 5.3以降で利用可能です。
  • 関数を使用する前に、add_image_size()を用いてカスタム画像サイズを登録することが推奨されます。
  • 返される配列のキーは画像サイズ名で、値にはwidth、height、cropが含まれます。

関連機能：