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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。