Custom HTML attribute in wp_get_attachment_image() call about wordpress-stubs

[johnbillion]

If there's a @param <something>|array and it's documented with an array hash notation then the @phpstan-param tag gets added with the array shape. So yes, a union type gets reduced to an array shape.

[szepeviktor]

Hello Victor!
Thank you for your report.

It boils down to your custom HTML attribute.
Please consider adding a stubs file to your PHPStan config that fits your usage of wp_get_attachment_image as this package is automatically generated.
I suggest you to add data-secondary to the list of allowed string.

[szepeviktor]

I see!!!
WP core has @param string|array $attr
we interpret it as @phpstan-param array{...

BTW I think this function cannot handle boolean attributes: $html .= " $name=" . '"' . $value . '"';
@UVLabs What is your actual HTML output?

[szepeviktor]

@johnbillion Could it be that we reduce UnionType to a simple array?

[UVLabs]

BTW I think this function cannot handle boolean attributes: $html .= " $name=" . '"' . $value . '"';
@UVLabs What is your actual HTML output?

@szepeviktor I'm not sure what you mean here? The function returns the image HTML

I've ignored the error for now but it looks like a false positive

[szepeviktor]

I'm not sure what you mean here?

What is your current HTML code that is printed by wp_get_attachment_image.
E.g. <img ... >

[UVLabs]

I'm not sure what you mean here?

What is your current HTML code that is printed by wp_get_attachment_image. E.g. <img ... >

@szepeviktor :

[szepeviktor]

Thank you!

Now it is sure that this function does not support "boolean HTML attributes".
It should be <img ... data-secondary />

[UVLabs]

@szepeviktor That photo was from a dump of the return, but I can see that when this renders on the page (Google Chrome) its as expected:

I changed the code to instead use an array:

wp_get_attachment_image( $gallery_attachment_ids[0], $image_size, false, array( 'class' => 'secondary-img' ) ); and PHP stan no longer throws the error

[UVLabs]

@szepeviktor I'm still not sure at this point if this was truly a false positive, the documentation is a little unclear for that particular parameter but if a string is allowed as per the wp.org doc, then there shouldn't have been error

[johnbillion]

The primary reason for this is parameters that accept string|array where the string is a URL query string which no sane person should be using to pass arguments.

[szepeviktor]

I changed the code to instead use an array

@UVLabs Thank you for using an array!