stream_preview_image() WordPress Function
This function inserts a preview image for a given video stream. The preview image is fetched from the video stream's provider. If the video stream is not live, the image will be the stream's most recent thumbnail.
stream_preview_image( int $post_id ) #
Streams image in post to browser, along with enqueued changes in $_REQUEST['history']
.
Parameters
- $post_id
(int)(Required)Attachment post ID.
Return
(bool) True on success, false on failure.
Source
File: wp-admin/includes/image-edit.php
function stream_preview_image( $post_id ) { $post = get_post( $post_id ); wp_raise_memory_limit( 'admin' ); $img = wp_get_image_editor( _load_image_to_edit_path( $post_id ) ); if ( is_wp_error( $img ) ) { return false; } $changes = ! empty( $_REQUEST['history'] ) ? json_decode( wp_unslash( $_REQUEST['history'] ) ) : null; if ( $changes ) { $img = image_edit_apply_changes( $img, $changes ); } // Scale the image. $size = $img->get_size(); $w = $size['width']; $h = $size['height']; $ratio = _image_get_preview_ratio( $w, $h ); $w2 = max( 1, $w * $ratio ); $h2 = max( 1, $h * $ratio ); if ( is_wp_error( $img->resize( $w2, $h2 ) ) ) { return false; } return wp_stream_image( $img, $post->post_mime_type, $post_id ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.9.0 | Introduced. |