Changeset 47060 for trunk/src/wp-includes/media.php

Timestamp:

01/11/2020 06:30:58 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:

• trunk/src/wp-includes/media.php (modified) (5 diffs)

trunk/src/wp-includes/media.php

@@ -186 +186 @@
  *                           or an array of width and height values in pixels (in that order).
  *                           Default 'medium'.
- * @return false|array Array containing the image URL, width, height, and boolean for whether
+ * @return array|false Array containing the image URL, width, height, and boolean for whether
  *                     the image is an intermediate size. False on failure.
  */
@@ -522 +522 @@
  * @param bool|array $crop   Optional. Whether to crop image to specified width and height or resize.
  *                           An array can specify positioning of the crop area. Default false.
- * @return false|array False on failure. Returned array matches parameters for `imagecopyresampled()`.
+ * @return array|false Returned array matches parameters for `imagecopyresampled()`. False on failure.
  */
 function image_resize_dimensions( $orig_w, $orig_h, $dest_w, $dest_h, $crop = false ) {
@@ -666 +666 @@
  * @param bool   $crop   Optional. Whether to crop image to specified width and height or resize.
  *                       Default false.
- * @return false|array False, if no image was created. Metadata array on success.
+ * @return array|false Metadata array on success. False if no image was created.
  */
 function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
@@ -741 +741 @@
  *                              of width and height values in pixels (in that order).
  *                              Default 'thumbnail'.
- * @return false|array $data {
+ * @return array|false $data {
  *     Array of file relative path, width, and height on success. Additionally includes absolute
  *     path and URL if registered size is passed to $size parameter. False on failure.
@@ -942 +942 @@
  *                                    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 false|array Returns an array (url, width, height, is_intermediate), or false, if no image is available.
+ * @return array|false Returns an array (url, width, height, is_intermediate), or false if no image is available.
  */
 function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) {