Make WordPress Core

Changeset 53546


Ignore:
Timestamp:
06/21/2022 11:13:17 AM (3 years ago)
Author:
SergeyBiryukov
Message:

Docs: Correct the return type for wp_save_image_file().

Since WordPress 3.5, wp_save_image_file() uses WP_Image_Editor classes under the hood to save the images.

While the save() method in those instances returns array|WP_Error and is documented as such, the return type of the wp_save_image_file() function was still left as bool.

A better solution would be to adjust the function to return the documented boolean type. However, doing that after 20+ major WP releases would be a backward compatibility break, so the documentation is now updated instead.

Includes:

  • Documenting the returned array using hash notation.
  • Adding a @since note for the $image parameter expecting a WP_Image_Editor instance.
  • Adding a @since note for the $filesize value being included in the returned array.

Follow-up to [22094], [22619], [52837].

Props jrf, SergeyBiryukov.
See #55646.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/image-edit.php

    r53302 r53546  
    352352 *
    353353 * @since 2.9.0
     354 * @since 3.5.0 The `$image` parameter expects a `WP_Image_Editor` instance.
     355 * @since 6.0.0 The `$filesize` value was added to the returned array.
    354356 *
    355357 * @param string          $filename  Name of the file to be saved.
     
    357359 * @param string          $mime_type The mime type of the image.
    358360 * @param int             $post_id   Attachment post ID.
    359  * @return bool True on success, false on failure.
     361 * @return array|WP_Error|bool {
     362 *     Array on success or WP_Error if the file failed to save.
     363 *     When called with a deprecated value for the `$image` parameter,
     364 *     i.e. a non-`WP_Image_Editor` image resource or `GdImage` instance,
     365 *     the function will return true on success, false on failure.
     366 *
     367 *     @type string $path      Path to the image file.
     368 *     @type string $file      Name of the image file.
     369 *     @type int    $width     Image width.
     370 *     @type int    $height    Image height.
     371 *     @type string $mime-type The mime type of the image.
     372 *     @type int    $filesize  File size of the image.
     373 * }
    360374 */
    361375function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
Note: See TracChangeset for help on using the changeset viewer.