Opened 6 years ago
Closed 5 years ago
#46113 closed defect (bug) (fixed)
Incongruent returned value for wp_get_attachment_image_src
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 5.5 | Priority: | normal |
Severity: | normal | Version: | 2.5 |
Component: | Media | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
As per docblock the function wp_get_attachment_image_src
will return false|array Returns an array (url, width, height, is_intermediate), or false, if no image is available.
Function wp_get_attachment_image_src
return an indexed array containing source, width and height, but not the intermediated value in case the internal call to image_downsize
return false.
It's this latter that will return the array containing all of the elements, therefore if it's false wp_get_attachment_image_src
will try to create them but will miss is_intermediated
value.
Attachments (1)
Change History (8)
#3
@
6 years ago
@joemcgill What adding a default value for it instead? This will make the function more predictable.
False would be a good choice, it's the same default in image_downsize
#5
@
5 years ago
- Milestone changed from Future Release to 5.5
- Owner set to johnbillion
- Status changed from new to accepted
I noticed this too when cleaning up the docs for this function. When the fallback icon is used, false
should be added as the fourth element in the returned array. The function docs also need updating to reflect this parameter, as the change I made in [47394] is technically not correct due to the inconsistent return value.
Good catch, @wido. The docs should be updated here to note that the fourth value in the array, i.e.
is_intermediate
is optional.