Introduce filter webp_uploads_pre_generate_additional_image_source to short-circuit generating additional image sources on upload

modules/images/webp-uploads/helper.php

@@ -59,12 +59,47 @@ function webp_uploads_get_upload_image_mime_transforms() {
  * @access private
  *
  * @param int    $attachment_id         The ID of the attachment from where this image would be created.
+ * @param string $image_size            The size name that would be used to create the image source, out of the registered subsizes.
  * @param array  $size_data             An array with the dimensions of the image: height, width and crop.
  * @param string $mime                  The target mime in which the image should be created.
  * @param string $destination_file_name The path where the file would be stored, including the extension. If empty, `generate_filename` is used to create the destination file name.
+ *
  * @return array|WP_Error An array with the file and filesize if the image was created correctly otherwise a WP_Error
  */
-function webp_uploads_generate_additional_image_source( $attachment_id, array $size_data, $mime, $destination_file_name = null ) {
+function webp_uploads_generate_additional_image_source( $attachment_id, $image_size, array $size_data, $mime, $destination_file_name = null ) {
+
+	/**
+	 * Filter to allow the generation of additional image sources, in which a defined mime type
+	 * can be transformed and create additional mime types for the file.
+	 *
+	 * Returning an image data array or WP_Error here effectively short-circuits the default logic to generate the image source.
+	 *
+	 * @since n.e.x.t
+	 *
+	 * @param array|null|WP_Error $image         Image data {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string} or null or WP_Error.
+	 * @param int                 $attachment_id The ID of the attachment from where this image would be created.
+	 * @param string              $image_size    The size name that would be used to create this image, out of the registered subsizes.
+	 * @param array               $size_data     An array with the dimensions of the image: height, width and crop {'height'=>int, 'width'=>int, 'crop'}.
+	 * @param string              $mime          The target mime in which the image should be created.
+	 * @return array|null|WP_Error An array with the file and filesize if the image was created correctly otherwise a WP_Error
+	 */
+	$image = apply_filters( 'webp_uploads_pre_generate_additional_image_source', null, $attachment_id, $image_size, $size_data, $mime );
+
+	if ( is_wp_error( $image ) ) {
+		return $image;
+	}
+
+	if (
+		is_array( $image )
+		&& ! empty( $image['file'] )
+		&& ! empty( $image['path'] )
+	) {
+		return array(
+			'file'     => $image['file'],
+			'filesize' => filesize( $image['path'] ),
+		);
+	}
+
 	$allowed_mimes = array_flip( wp_get_mime_types() );
 	if ( ! isset( $allowed_mimes[ $mime ] ) || ! is_string( $allowed_mimes[ $mime ] ) ) {
 		return new WP_Error( 'image_mime_type_invalid', __( 'The provided mime type is not allowed.', 'performance-lab' ) );
@@ -173,7 +208,7 @@ function webp_uploads_generate_image_size( $attachment_id, $size, $mime ) {
 		$size_data['crop'] = (bool) $sizes[ $size ]['crop'];
 	}
 
-	return webp_uploads_generate_additional_image_source( $attachment_id, $size_data, $mime );
+	return webp_uploads_generate_additional_image_source( $attachment_id, $size, $size_data, $mime );
 }
 
 /**

modules/images/webp-uploads/load.php

@@ -90,7 +90,7 @@ function webp_uploads_create_sources_property( array $metadata, $attachment_id )
 
 		$extension   = explode( '|', $allowed_mimes[ $targeted_mime ] );
 		$destination = trailingslashit( $original_directory ) . "{$filename}.{$extension[0]}";
-		$image       = webp_uploads_generate_additional_image_source( $attachment_id, $original_size_data, $targeted_mime, $destination );
+		$image       = webp_uploads_generate_additional_image_source( $attachment_id, 'full', $original_size_data, $targeted_mime, $destination );
 
 		if ( is_wp_error( $image ) ) {
 			continue;

tests/modules/images/webp-uploads/helper-tests.php

@@ -22,32 +22,37 @@ public function it_should_return_an_error_when_creating_an_additional_image_sour
 	public function data_provider_invalid_arguments_for_webp_uploads_generate_additional_image_source() {
 		yield 'when trying to use an attachment ID that does not exists' => array(
 			PHP_INT_MAX,
+			'medium',
 			array(),
 			'image/webp',
 		);
 
 		add_filter( 'wp_image_editors', '__return_empty_array' );
 		yield 'when no editor is present' => array(
 			$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
+			'medium',
 			array(),
 			'image/avif',
 		);
 
 		remove_filter( 'wp_image_editors', '__return_empty_array' );
 		yield 'when using a mime that is not supported' => array(
 			$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
+			'medium',
 			array(),
 			'image/avif',
 		);
 
 		yield 'when no dimension is provided' => array(
 			$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
+			'medium',
 			array(),
 			'image/webp',
 		);
 
 		yield 'when both dimensions are negative numbers' => array(
 			$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
+			'medium',
 			array(
 				'width'  => -10,
 				'height' => -20,
@@ -57,6 +62,7 @@ public function data_provider_invalid_arguments_for_webp_uploads_generate_additi
 
 		yield 'when both dimensions are zero' => array(
 			$this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' ),
+			'medium',
 			array(
 				'width'  => 0,
 				'height' => 0,
@@ -78,7 +84,7 @@ public function it_should_create_an_image_with_the_default_suffix_in_the_same_lo
 			'crop'   => true,
 		);
 
-		$result    = webp_uploads_generate_additional_image_source( $attachment_id, $size_data, 'image/webp' );
+		$result    = webp_uploads_generate_additional_image_source( $attachment_id, 'medium', $size_data, 'image/webp' );
 		$file      = get_attached_file( $attachment_id );
 		$directory = trailingslashit( pathinfo( $file, PATHINFO_DIRNAME ) );
 		$name      = pathinfo( $file, PATHINFO_FILENAME );
@@ -103,7 +109,7 @@ public function it_should_create_a_file_in_the_specified_location_with_the_speci
 			'crop'   => true,
 		);
 
-		$result = webp_uploads_generate_additional_image_source( $attachment_id, $size_data, 'image/webp', '/tmp/image.jpg' );
+		$result = webp_uploads_generate_additional_image_source( $attachment_id, 'medium', $size_data, 'image/webp', '/tmp/image.jpg' );
 
 		$this->assertIsArray( $result );
 		$this->assertArrayHasKey( 'filesize', $result );
@@ -231,4 +237,67 @@ function () {
 		$this->assertWPError( $result );
 		$this->assertSame( 'image_mime_type_not_supported', $result->get_error_code() );
 	}
+
+	/**
+	 * Create an image with the filter webp_uploads_pre_generate_additional_image_source added.
+	 *
+	 * @test
+	 */
+	public function it_should_create_an_image_with_filter_webp_uploads_pre_generate_additional_image_source() {
+		remove_all_filters( 'webp_uploads_pre_generate_additional_image_source' );
+
+		$attachment_id = $this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' );
+
+		add_filter(
+			'webp_uploads_pre_generate_additional_image_source',
+			function () {
+				return array(
+					'file' => 'image.webp',
+					'path' => '/tmp/image.webp',
+				);
+			}
+		);
+
+		$size_data = array(
+			'width'  => 300,
+			'height' => 300,
+			'crop'   => true,
+		);
+
+		$result = webp_uploads_generate_additional_image_source( $attachment_id, 'medium', $size_data, 'image/webp', '/tmp/image.jpg' );
+
+		$this->assertIsArray( $result );
+		$this->assertArrayHasKey( 'filesize', $result );
+		$this->assertArrayHasKey( 'file', $result );
+		$this->assertStringEndsWith( 'image.webp', $result['file'] );
+		$this->assertFileExists( '/tmp/image.webp' );
+	}
+
+	/**
+	 * Return an error when filter webp_uploads_pre_generate_additional_image_source returns WP_Error.
+	 *
+	 * @test
+	 */
+	public function it_should_return_an_error_when_filter_webp_uploads_pre_generate_additional_image_source_returns_wp_error() {
+		remove_all_filters( 'webp_uploads_pre_generate_additional_image_source' );
+
+		$attachment_id = $this->factory->attachment->create_upload_object( TESTS_PLUGIN_DIR . '/tests/testdata/modules/images/car.jpeg' );
+
+		add_filter(
+			'webp_uploads_pre_generate_additional_image_source',
+			function () {
+				return new WP_Error( 'image_additional_generated_error', __( 'Additional image was not generated.', 'performance-lab' ) );
+			}
+		);
+
+		$size_data = array(
+			'width'  => 300,
+			'height' => 300,
+			'crop'   => true,
+		);
+
+		$result = webp_uploads_generate_additional_image_source( $attachment_id, 'medium', $size_data, 'image/webp', '/tmp/image.jpg' );
+		$this->assertWPError( $result );
+		$this->assertSame( 'image_additional_generated_error', $result->get_error_code() );
+	}
 }