image_constrain_size_for_editor

説明

array image_constrain_size_for_editor( int $width, int $height [ , mixed $size = 'medium' ] )
イメージの縮小サイズを取得する。

パラメータ

  • $width
    イメージの幅を指定。
  • $height
    イメージの高さを指定。
  • $size
    縮小サイズ方法として幅と高さの配列か、文字列の'thumb'、'thumbnail'、'medium'、'large'、'full'を指定(省略時は'medium')。

返り値

縮小した幅と高さを格納した配列を返す。

注意

パラメータ$sizeに'thumb'、'thumbnail'、'medium'、'large'の何れかが指定されている場合は、管理ページのメディア設定にて指定しているそれぞれの幅と高さが適用される。なお、'large'の場合にはグローバル変数 $content_width get_option('large_size_w')の小さい値が幅の基準値となる。

使用例

  • 幅1024、高さ768のサムネイルサイズを取得する。
    <?php $size = image_constrain_size_for_editor( 1024, 768, 'thumb' ); ?>
  • 幅1024、高さ768を200×200に合わせて調整したサイズを取得する。
    <?php $size = image_constrain_size_for_editor( 1024, 768, array( 200, 200 ) ); ?>

フィルター

リサイズ後のサイズを返す前にeditor_max_image_sizeフィルターを実行し、そのフィルターの戻り値を wp_constrain_dimensions関数に渡し、その戻り値を返す。
apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/media.php

最終更新 : 2011年12月01日 13:43



お勧め

パスとURL(2011年10月6日 更新)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。