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