Changeset 50236

Timestamp:

02/08/2021 02:12:21 PM (4 years ago)

Author:

SergeyBiryukov

Message:

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

Props GeekPress, audrasjb, naveen17797.
Fixes #52183.

Location:

trunk/src/wp-includes

Files:

• media.php (modified) (1 diff)
• post-thumbnail-template.php (modified) (1 diff)

trunk/src/wp-includes/media.php

@@ -1125 +1125 @@
  *                                    width and height values in pixels (in that order). Default 'thumbnail'.
  * @param bool         $icon          Optional. Whether the image should be treated as an icon. Default false.
- * @return string|false Attachment URL or false if no image is available.
+ * @return string|false Attachment URL or false if no image is available. If `$size` does not match
+ *                      any registered image size, the original image URL will be returned.
  */
 function wp_get_attachment_image_url( $attachment_id, $size = 'thumbnail', $icon = false ) {

trunk/src/wp-includes/post-thumbnail-template.php

@@ -216 +216 @@
  *
  * @param int|WP_Post  $post Optional. Post ID or WP_Post object.  Default is global `$post`.
- * @param string|int[] $size Optional. Registered image size to retrieve the source for or a flat
- *                           array of height and width dimensions. Default 'post-thumbnail'.
- * @return string|false Post thumbnail URL or false if no URL is available.
+ * @param string|int[] $size Optional. Registered image size to retrieve the source for or a flat array
+ *                           of height and width dimensions. Default 'post-thumbnail'.
+ * @return string|false Post thumbnail URL or false if no image is available. If `$size` does not match
+ *                      any registered image size, the original image URL will be returned.
  */
 function get_the_post_thumbnail_url( $post = null, $size = 'post-thumbnail' ) {