get_the_post_thumbnail_url function returns original url if the size didnt exist

[naveen17797]

From the function description it should return false if the size does not exist.

Steps to replicate the issue

1. I uploaded a image via featured image field on the post edit screen.

2. I am calling this function inside the theme file like this

$medium_thumbnail_url = get_the_post_thumbnail_url( $post_id, 'medium');

But this function returns original url instead of returning false.

[naveen17797]

Additional information:

I disabled the medium size by going to settings > Media > setting the dimensions to 0x0

It wont be generated for any image, After featured image upload, the medium size image is not generated

[GeekPress]

@naveen17797 Your are confused because the @return description contains a mistake. It should be no image instead of no URL.

@SergeyBiryukov I attached a patch to update the @return description based on the wp_get_attachment_image_url description.

I don't know if we should be more specific in case the $size doesn't match a registered image.

e.g:

@return string|false Post thumbnail URL or false if no image is available.
                     If `$size` doesn't match a registerd image size, the original thumbnail URL
                     will be returned.

[GeekPress]

Update @return description

[audrasjb]

Hi, thanks for the patch @GeekPress,

@return string|false Post thumbnail URL or false if no image is available.
                     If `$size` doesn't match a registered image size, the original
                     thumbnail URL will be returned.

This proposal looks great to me. Can you please update the patch accordingly?

[audrasjb]

Maybe just replace "the original thumbnail URL will be returned" with "the original image URL will be returned".

[GeekPress]

More specific @return description for wp_get_attachment_image_url & get_the_post_thumbnail_url

[GeekPress]

Thanks @audrasjb for your feedback.

I've updated the patch. I also updated the @return description of wp_get_attachment_image_url to have the same @return statement than get_the_post_thumbnail_url

[audrasjb]

DocBlocks Coding standards fixes

[audrasjb]

Thanks for the second patch. I fixed few minor DocBlock issues, now I think it's ready for commit.

[SergeyBiryukov]

In 50236:

Docs: Clarify the @return value for wp_get_attachment_image_url() and get_the_post_thumbnail_url().

Props GeekPress, audrasjb, naveen17797.
Fixes #52183.