wp_get_additional_image_sizes()


WordPress関数wp_get_additional_image_sizes()は、登録された追加の画像サイズを取得するために使用されます。

構文

wp_get_additional_image_sizes();

説明

  • この関数は、テーマやプラグインで定義された追加の画像サイズを配列として返します。
  • 戻り値の配列には、幅（width）、高さ（height）、トリミング設定（crop）が含まれます。

例 1: 登録された追加画像サイズの取得

以下のコードは、追加画像サイズを取得し、それぞれを出力します。

<?php
$sizes = wp_get_additional_image_sizes();
foreach ( $sizes as $size => $details ) {
    echo $size . ': ' . $details['width'] . 'x' . $details['height'] . ' - ' . ( $details['crop'] ? 'Cropped' : 'Not Cropped' );
}
?>

例 2: 特定の画像サイズの幅と高さを取得

特定のサイズの幅と高さを出力します。

<?php
$sizes = wp_get_additional_image_sizes();
if ( isset( $sizes['custom-size'] ) ) {
    echo 'Width: ' . $sizes['custom-size']['width'];
    echo 'Height: ' . $sizes['custom-size']['height'];
}
?>

例 3: トリミング設定の確認

特定の画像サイズがトリミングされているかを確認します。

<?php
$sizes = wp_get_additional_image_sizes();
if ( isset( $sizes['custom-size'] ) && $sizes['custom-size']['crop'] ) {
    echo 'The custom-size is cropped.';
} else {
    echo 'The custom-size is not cropped.';
}
?>

例 4: すべての画像サイズ情報を取得

配列形式で画像サイズ情報を取得して確認します。

<?php
$sizes = wp_get_additional_image_sizes();
var_dump( $sizes );
?>

例 5: 管理画面に追加画像サイズを表示

以下のコードを使用して、追加画像サイズを管理画面に出力します。

<?php
add_action( 'admin_notices', function() {
    $sizes = wp_get_additional_image_sizes();
    foreach ( $sizes as $size => $details ) {
        echo '<p>' . $size . ': ' . $details['width'] . 'x' . $details['height'] . ' - ' . ( $details['crop'] ? 'Cropped' : 'Not Cropped' ) . '</p>';
    }
});
?>

注意点

  • この関数は登録された追加の画像サイズのみを返し、デフォルトの画像サイズ（thumbnail、medium、largeなど）は含まれません。
  • テーマやプラグインで画像サイズを追加する場合は、add_image_size()を使用してください。

関連機能：