Use function stub to override filtered return value typing

westonruter · westonruter · commit 3e8fed7fad17 · 2024-05-06T12:37:55.000-07:00
diff --git a/bin/phpstan/filtered-functions.stub b/bin/phpstan/filtered-functions.stub
@@ -0,0 +1,32 @@
+<?php
+/**
+ * Functions with filtered return values that extend what core returns.
+ *
+ * @package performance-lab
+ */
+
+/**
+ * Retrieves attachment metadata for attachment ID.
+ *
+ * This is a wrapper for {@see wp_get_attachment_metadata()} to add the typing which is augmented by the
+ * `wp_generate_attachment_metadata` via {@see dominant_color_metadata()} and {@see webp_uploads_create_sources_property()}.
+ *
+ * @since 2.1.0
+ * @since 6.0.0 The `$filesize` value was added to the returned array.
+ *
+ * @param int $attachment_id Attachment post ID. Defaults to global $post.
+ * @param bool $unfiltered    Optional. If true, filters are not run. Default false.
+ *
+ * @return array{
+ *     width: int,
+ *     height: int,
+ *     file: string,
+ *     sizes: array<string, array{ file: string, width: int, height: int, 'mime-type': string, sources?: array<string, array{ file: string, filesize: int }> }>,
+ *     image_meta: array<string, mixed>,
+ *     filesize: int,
+ *     sources?: array<string, array{ file: string, filesize: int }>,
+ *     has_transparency?: bool,
+ *     dominant_color?: string
+ * }|null Attachment metadata. Null on failure.
+ */
+function wp_get_attachment_metadata( int $attachment_id = 0, bool $unfiltered = false ): ?array {}
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -18,5 +18,7 @@ parameters:
 		# See <https://github.com/php-stubs/wordpress-stubs/issues/100>.
 		- vendor/phpstan/php-8-stubs/stubs/ext/standard/str_contains.php
 		- vendor/phpstan/php-8-stubs/stubs/ext/standard/str_starts_with.php
+	stubFiles:
+		- bin/phpstan/filtered-functions.stub
 	dynamicConstantNames:
 		- PERFLAB_OBJECT_CACHE_DROPIN_VERSION
diff --git a/plugins/webp-uploads/hooks.php b/plugins/webp-uploads/hooks.php
@@ -553,27 +553,7 @@ function webp_uploads_update_image_references( $content ) {
  * @return string The updated img tag.
  */
 function webp_uploads_img_tag_update_mime_type( $original_image, $context, $attachment_id ) {
-	$image = $original_image;
-
-	/**
-	 * Metadata potentially amended by webp_uploads_create_sources_property().
-	 *
-	 * Note the sources key is not normally present in the response for wp_get_attachment_metadata(). The sources
-	 * key here, however, is being injected via the 'wp_generate_attachment_metadata' filter via the
-	 * webp_uploads_create_sources_property() function.
-	 *
-	 * @see webp_uploads_create_sources_property()
-	 *
-	 * @var array{
-	 *          width: int,
-	 *          height: int,
-	 *          file: non-falsy-string,
-	 *          sizes: array,
-	 *          image_meta: array,
-	 *          filesize: int,
-	 *          sources?: array<string, array{ file: string, filesize: int }>
-	 *      } $metadata
-	 */
+	$image    = $original_image;
 	$metadata = wp_get_attachment_metadata( $attachment_id );
 
 	if ( empty( $metadata['file'] ) ) {
