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



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。