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.

  • Action hooks look like this: do_action( "hook_name" )
  • Filter hooks look like this: apply_filters( "hook_name", "what_to_filter" ).

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
215
216           /**
217            * Filter the WP_Image_Editor instance for the image to be streamed to the browser.
218            *
219            * @since 3.5.0
220            *
221            * @param WP_Image_Editor $image   WP_Image_Editor instance.
222            * @param int             $post_id Post ID.
223            */
224           $image = apply_filters( 'image_editor_save_pre', $image, $post_id );
225
226           if ( is_wp_error( $image->stream( $mime_type ) ) )
227                return false;
228
229           return true;
230      } else {
231           _deprecated_argument( __FUNCTION__, '3.5', __( '$image needs to be an WP_Image_Editor object' ) );
232
233           /**
 
Line Code
264  * @param WP_Image_Editor $image
265  * @param string $mime_type
266  * @param int $post_id
267  * @return bool
268  */
269 function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
270      if ( $image instanceof WP_Image_Editor ) {
271
272           /** This filter is documented in wp-admin/includes/image-edit.php */
273           $image = apply_filters( 'image_editor_save_pre', $image, $post_id );
274
275           /**
276            * Filter whether to skip saving the image file.
277            *
278            * Returning a non-null value will short-circuit the save method,
279            * returning that value instead.
280            *
281            * @since 3.5.0
282            *