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-gd.php

    r53317 r53547  
    426426     * @since 5.9.0 Renamed `$filename` to `$destfilename` to match parent class
    427427     *              for PHP 8 named parameter support.
     428     * @since 6.0.0 The `$filesize` value was added to the returned array.
    428429     *
    429430     * @param string|null $destfilename Optional. Destination filename. Default null.
    430431     * @param string|null $mime_type    Optional. The mime-type. Default null.
    431      * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
     432     * @return array|WP_Error {
     433     *     Array on success or WP_Error if the file failed to save.
     434     *
     435     *     @type string $path      Path to the image file.
     436     *     @type string $file      Name of the image file.
     437     *     @type int    $width     Image width.
     438     *     @type int    $height    Image height.
     439     *     @type string $mime-type The mime type of the image.
     440     *     @type int    $filesize  File size of the image.
     441     * }
    432442     */
    433443    public function save( $destfilename = null, $mime_type = null ) {
     
    443453
    444454    /**
     455     * @since 3.5.0
     456     * @since 6.0.0 The `$filesize` value was added to the returned array.
     457     *
    445458     * @param resource|GdImage $image
    446459     * @param string|null      $filename
    447460     * @param string|null      $mime_type
    448      * @return array|WP_Error
     461     * @return array|WP_Error {
     462     *     Array on success or WP_Error if the file failed to save.
     463     *
     464     *     @type string $path      Path to the image file.
     465     *     @type string $file      Name of the image file.
     466     *     @type int    $width     Image width.
     467     *     @type int    $height    Image height.
     468     *     @type string $mime-type The mime type of the image.
     469     *     @type int    $filesize  File size of the image.
     470     * }
    449471     */
    450472    protected function _save( $image, $filename = null, $mime_type = null ) {
Note: See TracChangeset for help on using the changeset viewer.