wppaste
WordPress

apply_filters( 'image_downsize', bool|array $downsize, int $id, string|int[] $size )

Since
2.5.0
Filters whether to preempt the output of image_downsize().

Description

Returning a truthy value from the filter will effectively short-circuit down-sizing the image, returning that value instead.

Compatibility

WordPress
since 2.5.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$downsizebool|array
Whether to short-circuit the image downsize.
$idint
Attachment ID for image.
$sizestring|int[]
Requested image size. Can be any registered image size name, or an array of width and height values in pixels (in that order).

Where this hook fires · 2

  • wp-includes/media.php:212image_downsize()
  • wp-includes/media.php:4662wp_prepare_attachment_for_js()

Source code

	 *	 * @param bool|array   $downsize Whether to short-circuit the image downsize.	 * @param int          $id       Attachment ID for image.	 * @param string|int[] $size     Requested image size. Can be any registered image size name, or	 *                               an array of width and height values in pixels (in that order).	 */	$out = apply_filters( 'image_downsize', false, $id, $size ); 	if ( $out ) {		return $out;	} 	$img_url          = wp_get_attachment_url( $id );

Changelog

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.