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



お勧め

フィードにサムネイル画像を追加する(2022年11月1日 更新)

WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

5.5の機能強化:コメントフォームのちょっとした改良(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3(以降Beta 3)」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

index.htmlでアーカイブページを表示させる(2011年10月14日 更新)

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた(こんなことを考えてるのは自分だけだろうか!?)。