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



お勧め

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。