Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: image_downsize

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

This hook occurs 2 times in this file.

Line Code
161       * Passing a truthy value to the filter will effectively short-circuit
162       * down-sizing the image, returning that value as output instead.
163       *
164       * @since 2.5.0
165       *
166       * @param bool         $downsize Whether to short-circuit the image downsize. Default false.
167       * @param int          $id       Attachment ID for image.
168       * @param array|string $size     Size of image, either array or string. Default 'medium'.
169       */
170      if ( $out = apply_filters( 'image_downsize', false, $id, $size ) ) {
171           return $out;
172      }
173
174      $img_url = wp_get_attachment_url($id);
175      $meta = wp_get_attachment_metadata($id);
176      $width = $height = 0;
177      $is_intermediate = false;
178      $img_url_basename = wp_basename($img_url);
179
 
Line Code
2790           unset( $possible_sizes['full'] );
2791
2792           // Loop through all potential sizes that may be chosen. Try to do this with some efficiency.
2793           // First: run the image_downsize filter. If it returns something, we can use its data.
2794           // If the filter does not return something, then image_downsize() is just an expensive
2795           // way to check the image metadata, which we do second.
2796           foreach ( $possible_sizes as $size => $label ) {
2797
2798                /** This filter is documented in wp-includes/media.php */
2799                if ( $downsize = apply_filters( 'image_downsize', false, $attachment->ID, $size ) ) {
2800                     if ( ! $downsize[3] )
2801                          continue;
2802                     $sizes[ $size ] = array(
2803                          'height'      => $downsize[2],
2804                          'width'       => $downsize[1],
2805                          'url'         => $downsize[0],
2806                          'orientation' => $downsize[2] > $downsize[1] ? 'portrait' : 'landscape',
2807                     );
2808                } elseif ( isset( $meta['sizes'][ $size ] ) ) {