image_constrain_size_for_editor

SummerySummery

Scale down the default size of an image.

Syntax

image_constrain_size_for_editor( int $width, int $height, string|array $size = 'medium', string $context = null )

DescriptionDescription

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’, ‘medium_large’ 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.

ParametersParameters

$width

(int) (Required) Width of the image in pixels.

$height

(int) (Required) Height of the image in pixels.

$size

(string|array) (Optional) Image size. Accepts any valid image size, or an array of width and height values in pixels (in that order).

Default value: 'medium'

$context

(string) (Optional) Could be 'display' (like in a theme) or 'edit' (like inserting into an editor).

Default value: null

ReturnReturn

(int[]) An array of width and height values.

  • (int) The maximum width in pixels.
  • '1'
    (int) The maximum height in pixels.

SourceSource

File: wp-includes/media.php


			

ChangelogChangelog

Changelog
Version Description
2.5.0 Introduced.
Scroll to Top