Make WordPress Core


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

Docs: Improve documentation for WP_Image_Editor::save() and related functions.

Includes:

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

This affects:

  • wp_generate_attachment_metadata()
  • wp_get_attachment_metadata()
  • WP_Image_Editor::save()
  • WP_Image_Editor_GD::save() and ::_save()
  • WP_Image_Editor_Imagick::save() and ::_save()

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

See #55646.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-image-editor.php

    r53317 r53547  
    7676     *
    7777     * @since 3.5.0
     78     * @since 6.0.0 The `$filesize` value was added to the returned array.
    7879     * @abstract
    7980     *
    8081     * @param string $destfilename Optional. Destination filename. Default null.
    8182     * @param string $mime_type    Optional. The mime-type. Default null.
    82      * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
     83     * @return array|WP_Error {
     84     *     Array on success or WP_Error if the file failed to save.
     85     *
     86     *     @type string $path      Path to the image file.
     87     *     @type string $file      Name of the image file.
     88     *     @type int    $width     Image width.
     89     *     @type int    $height    Image height.
     90     *     @type string $mime-type The mime type of the image.
     91     *     @type int    $filesize  File size of the image.
     92     * }
    8393     */
    8494    abstract public function save( $destfilename = null, $mime_type = null );
Note: See TracChangeset for help on using the changeset viewer.