Update PHPStan level to 3

[westonruter]

See #775.

This fixes the following PHPStan issues:

[ERROR] Found 42 errors

------ ----------------------------------------------------------------------------------------------------------------------------------------- 
  Line   plugins/dominant-color-images/hooks.php                                                                                                  
 ------ ----------------------------------------------------------------------------------------------------------------------------------------- 
  66     Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
  68     Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
  130    Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
  133    Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
  135    Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
 ------ ----------------------------------------------------------------------------------------------------------------------------------------- 

 ------ ---------------------------------------- 
  Line   plugins/webp-uploads/hooks.php          
 ------ ---------------------------------------- 
  301    Cannot assign offset string to string.  
 ------ ---------------------------------------- 

 ------ ----------------------------------------------------- 
  Line   tests/includes/admin/server-timing-tests.php         
 ------ ----------------------------------------------------- 
  72     Offset 'perflab-server…' does not exist on array{}.  
  76     Offset 'perflab-server…' does not exist on array{}.  
 ------ ----------------------------------------------------- 

 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 
  Line   tests/plugins/webp-uploads/image-edit-tests.php                                                                                         
 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 
  45     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  81     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  91     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  181    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  182    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  220    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  324    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 

 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 
  Line   tests/plugins/webp-uploads/load-tests.php                                                                                               
 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 
  56     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  57     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  88     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  89     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  119    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  120    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  150    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  151    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  329    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  342    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  363    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  369    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  390    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  394    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  484    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  484    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  530    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  530    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  589    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  782    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  783    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  783    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  809    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 

 ------ ------------------------------------------------------ 
  Line   tests/plugins/webp-uploads/rest-api-tests.php         
 ------ ------------------------------------------------------ 
  37     Cannot assign offset 'id' to WP_REST_Request<array>.  
  37     WP_REST_Request<array> does not accept int|WP_Error.  
  83     Cannot assign offset 'id' to WP_REST_Request<array>.  
  83     WP_REST_Request<array> does not accept int|WP_Error.  
 ------ ------------------------------------------------------   

Please review individual commits for changes.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: westonruter <westonruter@git.wordpress.org>
Co-authored-by: mukeshpanchal27 <mukesh27@git.wordpress.org>
Co-authored-by: thelovekesh <thelovekesh@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[westonruter]

Checks like this and the use of mixed as a possible param type are needed because plugins can add filters that stick any type in for $metadata.

[westonruter]

Note that webp_uploads_filter_image_editor_output_format() is added as a filter for image_editor_output_format. This filter is defined as taking these params:

		 * @param string[] $output_format {
		 *     An array of mime type mappings. Maps a source mime type to a new
		 *     destination mime type. Default empty array.
		 *
		 *     @type string ...$0 The new mime type.
		 * }
		 * @param string $filename  Path to the image.
		 * @param string $mime_type The source image mime type.

So the use of string here for $output_format is incorrect. It should have been array<string, string> in the plugin, and in core string[] is not as specific as it could be (since it implies numeric keys).

Additionally, I tried using just string PHP types for $filename and $mimetype, but when running unit tests I got a failure. This is because the function that applies the filter is \WP_Image_Editor::get_output_format() and this function takes null as default values for $filename and $mime_type, which is what is passed when using a factory to create an image during testing. So core should actually be typing the filter:

		 * @param string|null $filename  Path to the image.
		 * @param string|null $mime_type The source image mime type.

These are accounted for with the new function signature for webp_uploads_filter_image_editor_output_format().

[westonruter]

PHPStan was complaining here:

  37     Cannot assign offset 'id' to WP_REST_Request<array>.  
  37     WP_REST_Request<array> does not accept int|WP_Error.

Apparently WP_REST_Request is not typed sufficiently in core for PHPStan to accept setting an array offset. So opting for the set_param() method is an easy fix for this.

[mukeshpanchal27]

Suggested change

	* @param int $attachment_id Attachment post ID. Defaults to global $post.
	* @param int $attachment_id Attachment post ID. Defaults 0.

[westonruter]

True, but wp_get_attachment_metadata defaults to $post which is what this function will do when zero is passed. I copied this phpdoc from core.

[westonruter]

Actually, instead of adding a helper wrapper function with the type definition, maybe it would be better to add a stub function definition for PHPStan to read?

[thelovekesh]

Yes, a stub is better for consistent PHPDoc comments.

[westonruter]

I've implemented the stub in 3e8fed7 which improved a lot.

[westonruter]

This is all eliminated because of the introduction of the function stub which includes the additional typing for the array keys added by filters in the webp-uploads and dominant-color-images plugins.