Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: image_editor_save_pre

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
268
269           /**
270            * Filters the WP_Image_Editor instance for the image to be streamed to the browser.
271            *
272            * @since 3.5.0
273            *
274            * @param WP_Image_Editor $image         The image editor instance.
275            * @param int             $attachment_id The attachment post ID.
276            */
277           $image = apply_filters( 'image_editor_save_pre', $image, $attachment_id );
278
279           if ( is_wp_error( $image->stream( $mime_type ) ) ) {
280                return false;
281           }
282
283           return true;
284      } else {
285           /* translators: 1: $image, 2: WP_Image_Editor */
286           _deprecated_argument( __FUNCTION__, '3.5.0', sprintf( __( '%1$s needs to be a %2$s object.' ), '$image', 'WP_Image_Editor' ) );
 
Line Code
321  * @param WP_Image_Editor $image     The image editor instance.
322  * @param string          $mime_type The mime type of the image.
323  * @param int             $post_id   Attachment post ID.
324  * @return bool True on success, false on failure.
325  */
326 function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
327      if ( $image instanceof WP_Image_Editor ) {
328
329           /** This filter is documented in wp-admin/includes/image-edit.php */
330           $image = apply_filters( 'image_editor_save_pre', $image, $post_id );
331
332           /**
333            * Filters whether to skip saving the image file.
334            *
335            * Returning a non-null value will short-circuit the save method,
336            * returning that value instead.
337            *
338            * @since 3.5.0
339            *