Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Media: Add file existence check in wp_get_image_mime() #7761

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

himanshupathak95
Copy link

Trac ticket: Core-62347

Description

The wp_get_image_mime() function currently attempts to read file contents without first verifying if the file exists or is readable. This can result in PHP warnings being written to error logs, especially in environments where WP_DEBUG is enabled.

This PR adds appropriate checks at the beginning of the function to prevent these warnings while maintaining the existing behavior of returning false for invalid images.

Changes proposed in this Pull Request:

  • Add file_exists() check at the start of wp_get_image_mime()
  • Add is_readable() check to ensure file permissions allow reading

Benefits:

  • Reduced Error Logs: Prevents unnecessary PHP warnings from filling up error logs, making actual errors easier to identify
  • Improved Debugging: Makes debugging easier by eliminating noise from non-critical file access warnings
  • Better Error Handling: Provides more predictable behavior by explicitly checking file accessibility before attempting operations
  • Best Practices: Follows PHP best practices by validating resources before attempting to use them

The `wp_get_image_mime()` function previously attempted to read file contents
without checking if the file exists or is readable, which could lead to
PHP warnings in error logs.

Add checks at the start of the function to return false early if the file
doesn't exist or isn't readable. This prevents unnecessary warnings while
maintaining the existing behavior of returning false for invalid images.
Copy link

Hi @himanshupathak95! 👋

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 the Core Handbook.

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

Copy link

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 abcd95.

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

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.

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.

1 participant