wp_stream_image

Streams image in WP_Image_Editor to browser.

Description

wp_stream_image( (WP_Image_Editor) $image, (string) $mime_type, (int) $post_id ); 

Provided for backcompat reasons

Parameters (3)

0. $image (WP_Image_Editor)
The image.
1. $mime_type (string)
The mime type.
2. $post_id (int)
The post id.

Usage

  1. if ( !function_exists( 'wp_stream_image' ) ) { 
  2.     require_once ABSPATH . '/wp-admin/includes/image-edit.php'; 
  3. } 
  4.   
  5. // The image. 
  6. $image = null; 
  7.   
  8. // The mime type. 
  9. $mime_type = ''; 
  10.   
  11. // The post id. 
  12. $post_id = -1; 
  13.   
  14. // NOTICE! Understand what this does before running. 
  15. $result = wp_stream_image($image, $mime_type, $post_id); 
  16.     

Defined (1)

The function is defined in the following location(s).

/wp-admin/includes/image-edit.php  
  1. function wp_stream_image( $image, $mime_type, $post_id ) { 
  2.     if ( $image instanceof WP_Image_Editor ) { 
  3.  
  4.         /** 
  5.          * Filters the WP_Image_Editor instance for the image to be streamed to the browser. 
  6.          * 
  7.          * @since 3.5.0 
  8.          * 
  9.          * @param WP_Image_Editor $image   WP_Image_Editor instance. 
  10.          * @param int             $post_id Post ID. 
  11.          */ 
  12.         $image = apply_filters( 'image_editor_save_pre', $image, $post_id ); 
  13.  
  14.         if ( is_wp_error( $image->stream( $mime_type ) ) ) 
  15.             return false; 
  16.  
  17.         return true; 
  18.     } else { 
  19.         _deprecated_argument( __FUNCTION__, '3.5.0', __( '$image needs to be an WP_Image_Editor object' ) ); 
  20.  
  21.         /** 
  22.          * Filters the GD image resource to be streamed to the browser. 
  23.          * 
  24.          * @since 2.9.0 
  25.          * @deprecated 3.5.0 Use image_editor_save_pre instead. 
  26.          * 
  27.          * @param resource $image   Image resource to be streamed. 
  28.          * @param int      $post_id Post ID. 
  29.          */ 
  30.         $image = apply_filters( 'image_save_pre', $image, $post_id ); 
  31.  
  32.         switch ( $mime_type ) { 
  33.             case 'image/jpeg': 
  34.                 header( 'Content-Type: image/jpeg' ); 
  35.                 return imagejpeg( $image, null, 90 ); 
  36.             case 'image/png': 
  37.                 header( 'Content-Type: image/png' ); 
  38.                 return imagepng( $image ); 
  39.             case 'image/gif': 
  40.                 header( 'Content-Type: image/gif' ); 
  41.                 return imagegif( $image ); 
  42.             default: 
  43.                 return false; 
  44.         } 
  45.     } 
  46. }