Skip to content

Fix wrong file size when scaling images.#6406

Closed
pls78 wants to merge 5 commits intoWordPress:trunkfrom
pls78:59684-fix-scaled-images-wrong-file-size
Closed

Fix wrong file size when scaling images.#6406
pls78 wants to merge 5 commits intoWordPress:trunkfrom
pls78:59684-fix-scaled-images-wrong-file-size

Conversation

@pls78
Copy link

@pls78 pls78 commented Apr 18, 2024

What

This PR fixes the wrong file size displayed in the media library when a user resizes an image. At the same time, if the user decides to revert the changes made to the image, this PR makes possible to revert to the original file size.

Why

This PR solves the issue described in the following Trac ticket: https://core.trac.wordpress.org/ticket/59684

How

  • In the wp_save_image function I collect the array returned by wp_save_image_file, which contains the file size of the resized image, and add it to the attachment metadata array as $meta['filesize']
    • This allows to show the correct file size when the image is scaled
  • Before doing this I save the original file size in the $backup_sizes array, along with the image filename and dimensions
    • This allows to retrieve the original file size in case the user reverts the changes made to the image size
  • In the wp_restore_image function I then read back from $backup_sizes the original file size and restore it when the user reverts back to the original size

Test instructions

Test the scale image case
  • Go to Media -> Add New Media File and upload an image
    • take note of the image size
    Screenshot 2024-04-18 at 23 12 22
  • Select the image you just uploaded and click on Edit Image
    • click on Scale and specify the new width and height
  • Close the modal and select the image you just resized
    • verify the file size is decreased
    Screenshot 2024-04-18 at 23 16 48
Test the restore original image case
  • Select the image you just resized and click on Edit Image
    • click on RESTORE ORIGINAL IMAGE -> Restore Image
  • Close the modal and select the image you just restored
    • verify the file size is back to its original value

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions
Copy link

Hi @pls78! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in this blog post.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

@github-actions
Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@pls78 pls78 marked this pull request as ready for review April 18, 2024 21:41
@github-actions
Copy link

github-actions bot commented Apr 18, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props pls78, peterwilsoncc.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Contributor

@peterwilsoncc peterwilsoncc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a minor bug in the restore functionality, noted inline.

@peterwilsoncc
Copy link
Contributor

@pls78 I took the liberty of pushing some code to your branch:

  • a fix to potential error when restoring I noted a few days ago
  • merged in trunk
  • added a couple of unit tests to be sure the file size is modified & restored as expected

@peterwilsoncc
Copy link
Contributor

Merged r59202 / 6a07d7a

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants