概要
has_image_size 関数は、指定されたイメージサイズが WordPress に登録されているかどうかを調べるための関数です。この関数は、テーマやプラグインの開発時に、特定の画像サイズが存在するかどうかを確認するためによく使用されます。以下は、この関数がよく使われる場面の例です。
- 特定の画像サイズを含むギャラリーの作成
- 自動サムネイル生成の条件チェック
- カスタムイメージサイズを使用する際のバリデーション
- 画像サイズに応じたカスタムテンプレートの適用
- メディアアップロード時のイメージサイズ制御
- レスポンシブデザインにおける画像表示の最適化
- プラグインの設定画面でのイメージサイズ確認
- テーマの設定オプションにおけるサンプル画像の表示確認
構文
has_image_size( $name );
パラメータ
$name(string) :チェックしたいイメージサイズの名前。
戻り値
- (bool) : 指定されたイメージサイズが登録されている場合は
true、それ以外はfalse。
関連する関数
バージョン
- この関数は WordPress バージョン 3.1 以降で使用可能です。
コアファイルのパス
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 |
非推奨または削除されたバージョン
- 特定の非推奨または削除されたバージョンはありません。