wp_save_image_file │ filter-hook │ WP 2.9.0

Filters whether to skip saving the image file.

Returning a non-null value will short-circuit the save method, returning that value instead.

Usage

add_filter( 'wp_save_image_file', 'wp_kama_save_image_file_filter', 10, 3 );

/**
 * Function for `wp_save_image_file` filter-hook.
 * 
 * @param bool|null        $override Value to return instead of saving.
 * @param string           $filename Name of the file to be saved.
 * @param resource|GdImage $image    Image resource or GdImage instance.
 *
 * @return bool|null
 */
function wp_kama_save_image_file_filter( $override, $filename, $image ){

	// filter...
	return $override;
}

$override(true|false|null)

Value to return instead of saving.
Default: null

$filename(string)

Name of the file to be saved.

$image(resource|GdImage)

Image resource or GdImage instance.

Changelog

Where the hook is called

$saved = apply_filters_deprecated(
	'wp_save_image_file',
	array( null, $filename, $image, $mime_type, $post_id ),
	'3.5.0',
	'wp_save_image_editor_file'
);

Where the hook is used in WordPress