WordPress.org

Ready to get started?Download WordPress

Codex

Function Reference/image constrain size for editor

Contents

Description

Scale down the default size of an image.

This is so that the image is a better fit for the editor and theme.

The $size parameter accepts either an array or a string. The supported string values are 'thumb' or 'thumbnail' for the given thumbnail size or defaults at 128 width and 96 height in pixels. Also supported for the string value is 'medium' and 'full'. The 'full' isn't actually supported, but any value other than the supported will result in the content_width size or 500 if that is not set.

Finally, there is a filter named, 'editor_max_image_size' that will be called on the calculated array for width and height, respectively. The second parameter will be the value that was in the $size parameter. The returned type for the hook is an array with the width as the first element and the height as the second element.

Important (when dealing with the default sizes): Remember, that there's some automagically call to the options table. It will set the $max_/$min_width to what you defined under "admin UI" » "Settings" » "Media" and can't get overwritten without some dirty hacks to get_option() filters.

Usage

<?php image_constrain_size_for_editor$width$height$size ); ?>

Parameters

$width
(int) (required) Width of the image
Default: None
$height
(int) (required) Height of the image
Default: None
$size
(string|array) (optional) Size of what the result image should be.
Default: medium

Return Values

(array) 
Width and height of what the result image should resize to.

Change Log

Since: 2.5

Source File

image_constrain_size_for_editor() is located in wp-includes/media.php