webp-uploads
Last commit date
deprecated.php
3 weeks ago
helper.php
3 weeks ago
hooks.php
3 weeks ago
image-edit.php
3 weeks ago
load.php
3 weeks ago
picture-element.php
3 weeks ago
readme.txt
3 weeks ago
rest-api.php
3 weeks ago
settings.php
3 weeks ago
uninstall.php
3 weeks ago
readme.txt
238 lines
| 1 | === Modern Image Formats === |
| 2 | |
| 3 | Contributors: wordpressdotorg |
| 4 | Tested up to: 7.0 |
| 5 | Stable tag: 2.7.1 |
| 6 | License: GPLv2 or later |
| 7 | License URI: https://www.gnu.org/licenses/gpl-2.0.html |
| 8 | Tags: performance, images, webp, avif, modern image formats |
| 9 | |
| 10 | Converts images to more modern formats such as WebP or AVIF during upload. |
| 11 | |
| 12 | == Description == |
| 13 | |
| 14 | This plugin adds WebP and AVIF support for media uploads within the WordPress application. By default, AVIF images will be generated if supported on the hosting server, otherwise WebP will be used as the output format. When both formats are available, the output format can be selected under `Settings > Media`. Modern images will be generated only for new uploads, pre-existing images will only converted to a modern format if images are regenerated. Images can be regenerated with a plugin like [Regenerate Thumbnails](https://wordpress.org/plugins/regenerate-thumbnails/) or via WP-CLI with the `wp media regenerate` [command](https://developer.wordpress.org/cli/commands/media/regenerate/). |
| 15 | |
| 16 | By default, only modern image format sub-sizes will be generated for JPEG or PNG uploads - only the original uploaded file will still exist as a JPEG/PNG image, generated image sizes will be WebP or AVIF files. To change this behavior, there is a checkbox in `Settings > Media` "Output fallback images" that - when checked - will result in the plugin generating both the original format as well as WebP or AVIF images for every sub-size (noting again that this will only affect newly uploaded images, i.e. after making said change). |
| 17 | |
| 18 | _This plugin was formerly known as WebP Uploads._ |
| 19 | |
| 20 | == Installation == |
| 21 | |
| 22 | = Installation from within WordPress = |
| 23 | |
| 24 | 1. Visit **Plugins > Add New**. |
| 25 | 2. Search for **Modern Image Formats**. |
| 26 | 3. Install and activate the **Modern Image Formats** plugin. |
| 27 | |
| 28 | = Manual installation = |
| 29 | |
| 30 | 1. Upload the entire `webp-uploads` folder to the `/wp-content/plugins/` directory. |
| 31 | 2. Visit **Plugins**. |
| 32 | 3. Activate the **Modern Image Formats** plugin. |
| 33 | |
| 34 | = After activation = |
| 35 | |
| 36 | 1. Visit the **Settings > Media** admin screen. |
| 37 | 2. Use the controls in the **Modern Image Formats** section to configure modern image formats. |
| 38 | |
| 39 | == Frequently Asked Questions == |
| 40 | |
| 41 | = Where can I submit my plugin feedback? = |
| 42 | |
| 43 | Feedback is encouraged and much appreciated, especially since this plugin may contain future WordPress core features. If you have suggestions or requests for new features, you can [submit them as an issue in the WordPress Performance Team's GitHub repository](https://github.com/WordPress/performance/issues/new/choose). If you need help with troubleshooting or have a question about the plugin, please [create a new topic on our support forum](https://wordpress.org/support/plugin/webp-uploads/#new-topic-0). |
| 44 | |
| 45 | = Where can I report security bugs? = |
| 46 | |
| 47 | The Performance team and WordPress community take security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. |
| 48 | |
| 49 | To report a security issue, please visit the [WordPress HackerOne](https://hackerone.com/wordpress) program. |
| 50 | |
| 51 | = How can I contribute to the plugin? = |
| 52 | |
| 53 | Contributions are always welcome! Learn more about how to get involved in the [Core Performance Team Handbook](https://make.wordpress.org/performance/handbook/get-involved/). |
| 54 | |
| 55 | = I've activated the Modern Image Formats plugin, but WebP images are not always generated when I upload a JPEG image. Why? = |
| 56 | |
| 57 | There are two primary reasons that a WebP image may not be generated: |
| 58 | |
| 59 | 1. The Modern Image Formats plugin has identified that the WebP version of the uploaded JPEG image would have a larger file size than the original JPEG image, so it does not generate the WebP version. |
| 60 | 2. The JPEG image was not uploaded to the [Media Library](https://wordpress.com/support/media/). At this time, WebP versions are only generated for images to the Media Library. WebP versions are not generated for JPEG images that are added to your site in other ways, such as in a template file or the [Customizer](https://wordpress.com/support/customizer/). |
| 61 | |
| 62 | = With the Modern Image Formats plugin activated, will the plugin generate JPEG and WebP versions of every image that I upload? = |
| 63 | |
| 64 | By default, the Modern Image Formats plugin will only generate WebP versions of the images that you upload. If you wish to have both WebP **and** JPEG versions generated, you can navigate to **Settings > Media** and enable the **Generate JPEG files in addition to WebP** option. |
| 65 | |
| 66 | == Changelog == |
| 67 | |
| 68 | = 2.7.1 = |
| 69 | |
| 70 | **Bug Fixes** |
| 71 | |
| 72 | * Prevent fatal error in `webp_uploads_filter_wp_get_attachment_image()` when `wp_get_attachment_image_src()` returns false and during `rest_prepare_attachment` filtering. ([2565](https://github.com/WordPress/performance/pull/2565)) |
| 73 | |
| 74 | = 2.7.0 = |
| 75 | |
| 76 | **Enhancements** |
| 77 | |
| 78 | * Add explanation for discarded modern image outputs. ([2518](https://github.com/WordPress/performance/pull/2518)) |
| 79 | * Link to FAQ from settings section. ([2480](https://github.com/WordPress/performance/pull/2480)) |
| 80 | * Rewrite `img` tags output by `wp_get_attachment_image()`. ([2451](https://github.com/WordPress/performance/pull/2451)) |
| 81 | |
| 82 | **Bug Fixes** |
| 83 | |
| 84 | * Disable AVIF when ImageMagick does not support AVIF transparency. ([2540](https://github.com/WordPress/performance/pull/2540)) |
| 85 | |
| 86 | = 2.6.1 = |
| 87 | |
| 88 | **Bug Fixes** |
| 89 | |
| 90 | * Add a simple PHP version check around a deprecated function. ([2285](https://github.com/WordPress/performance/pull/2285)) |
| 91 | * Fix missing `PICTURE` element support for post thumbnail and add missing Modern Image Formats support for Widget block. ([2179](https://github.com/WordPress/performance/pull/2179)) |
| 92 | |
| 93 | = 2.6.0 = |
| 94 | |
| 95 | **Bug Fixes** |
| 96 | |
| 97 | * Use modern image formats in background images for Cover blocks and Group blocks. ([2121](https://github.com/WordPress/performance/pull/2121)) |
| 98 | * Fixes palette-based PNG uploads failing original full-size AVIF/WebP conversion under GD. ([2024](https://github.com/WordPress/performance/pull/2024)) |
| 99 | |
| 100 | = 2.5.1 = |
| 101 | |
| 102 | **Bug Fixes** |
| 103 | |
| 104 | * Fix Modern Image Format not cropping image if crop is an array. ([1887](https://github.com/WordPress/performance/pull/1887)) |
| 105 | * Fix incorrect image size selection in `PICTURE` element. ([1885](https://github.com/WordPress/performance/pull/1885)) |
| 106 | |
| 107 | = 2.5.0 = |
| 108 | |
| 109 | **Enhancements** |
| 110 | |
| 111 | * Switch to `wp_content_img_tag` filter for improved image handling. ([1772](https://github.com/WordPress/performance/pull/1772)) |
| 112 | |
| 113 | = 2.4.0 = |
| 114 | |
| 115 | **Enhancements** |
| 116 | |
| 117 | * Automatically opt into 1536x1536 and 2048x2048 sizes when generating fallback images. ([1679](https://github.com/WordPress/performance/pull/1679)) |
| 118 | * Convert WebP to AVIF on upload. ([1724](https://github.com/WordPress/performance/pull/1724)) |
| 119 | * Enable end user opt-in to generate all sizes in fallback format. ([1689](https://github.com/WordPress/performance/pull/1689)) |
| 120 | |
| 121 | = 2.3.0 = |
| 122 | |
| 123 | **Enhancements** |
| 124 | |
| 125 | * Introduce `webp_uploads_get_file_mime_type` helper function. ([1642](https://github.com/WordPress/performance/pull/1642)) |
| 126 | * Rename `webp_uploads_get_file_mime_type` to `webp_uploads_get_attachment_file_mime_type` to clarify scope. ([1662](https://github.com/WordPress/performance/pull/1662)) |
| 127 | |
| 128 | **Bug Fixes** |
| 129 | |
| 130 | * Fix bug that would prevent uploaded images from being converted to the intended output format when having fallback formats enabled. ([1635](https://github.com/WordPress/performance/pull/1635)) |
| 131 | |
| 132 | = 2.2.0 = |
| 133 | |
| 134 | **Enhancements** |
| 135 | |
| 136 | * Convert uploaded PNG files to AVIF or WebP. ([1421](https://github.com/WordPress/performance/pull/1421)) |
| 137 | |
| 138 | **Bug Fixes** |
| 139 | |
| 140 | * Account for responsive images being disabled when generating a PICTURE element. ([1449](https://github.com/WordPress/performance/pull/1449)) |
| 141 | |
| 142 | = 2.1.0 = |
| 143 | |
| 144 | **Enhancements** |
| 145 | |
| 146 | * Improve disabling checkbox for Picture Element on Media settings screen. ([1470](https://github.com/WordPress/performance/pull/1470)) |
| 147 | |
| 148 | **Bug Fixes** |
| 149 | |
| 150 | * Add missing full size image in PICTURE > SOURCE srcset. ([1437](https://github.com/WordPress/performance/pull/1437)) |
| 151 | * Correct the fallback image in PICTURE element. ([1408](https://github.com/WordPress/performance/pull/1408)) |
| 152 | * Don't wrap PICTURE element if JPEG fallback is not available. ([1450](https://github.com/WordPress/performance/pull/1450)) |
| 153 | * Fix setting sizes attribute on PICTURE > SOURCE elements. ([1354](https://github.com/WordPress/performance/pull/1354)) |
| 154 | * Remove string type hint from webp_uploads_sanitize_image_format() to prevent possible fatal error. ([1410](https://github.com/WordPress/performance/pull/1410)) |
| 155 | |
| 156 | **Documentation** |
| 157 | |
| 158 | * Explain how to regenerate images in the Modern Image Formats readme. ([1348](https://github.com/WordPress/performance/pull/1348)) |
| 159 | |
| 160 | = 2.0.2 = |
| 161 | |
| 162 | **Enhancements** |
| 163 | |
| 164 | * I18N: Add context to Modern Image Formats section title. ([1287](https://github.com/WordPress/performance/pull/1287)) |
| 165 | |
| 166 | **Bug Fixes** |
| 167 | |
| 168 | * Improve compatibility of styling picture elements. ([1307](https://github.com/WordPress/performance/pull/1307)) |
| 169 | |
| 170 | = 2.0.1 = |
| 171 | |
| 172 | **Bug Fixes** |
| 173 | |
| 174 | * Fix fatal error when another the_content filter callback returns null instead of a string. ([1283](https://github.com/WordPress/performance/pull/1283)) |
| 175 | |
| 176 | = 2.0.0 = |
| 177 | |
| 178 | **Features** |
| 179 | |
| 180 | * Add `picture` element support. ([73](https://github.com/WordPress/performance/pull/73)) |
| 181 | * Add AVIF image format support. Add setting for output image format to choose between WebP and AVIF. ([1176](https://github.com/WordPress/performance/pull/1176)) |
| 182 | |
| 183 | **Enhancements** |
| 184 | |
| 185 | * Improve Settings->Media controls for Modern Image Formats. ([1273](https://github.com/WordPress/performance/pull/1273)) |
| 186 | * Remove obsolete fallback script now that picture element is supported. ([1269](https://github.com/WordPress/performance/pull/1269)) |
| 187 | |
| 188 | = 1.1.1 = |
| 189 | |
| 190 | **Enhancements** |
| 191 | |
| 192 | * Prepend Settings link in webp-uploads. ([1146](https://github.com/WordPress/performance/pull/1146)) |
| 193 | * Improve overall code quality with stricter static analysis checks. ([775](https://github.com/WordPress/performance/issues/775)) |
| 194 | * Bump minimum PHP requirement to 7.2. ([1130](https://github.com/WordPress/performance/pull/1130)) |
| 195 | |
| 196 | **Documentation** |
| 197 | |
| 198 | * Updated inline documentation. ([1160](https://github.com/WordPress/performance/pull/1160)) |
| 199 | |
| 200 | = 1.1.0 = |
| 201 | |
| 202 | * Add link to WebP settings to plugins table. ([1036](https://github.com/WordPress/performance/pull/1036)) |
| 203 | * Rename plugin to "Modern Image Formats". ([1101](https://github.com/WordPress/performance/pull/1101)) |
| 204 | * Use plugin slug for generator tag. ([1103](https://github.com/WordPress/performance/pull/1103)) |
| 205 | * Delete option when uninstalling the Modern Image Formats plugin. ([1116](https://github.com/WordPress/performance/pull/1116)) |
| 206 | * Bump minimum required WP version to 6.4. ([1062](https://github.com/WordPress/performance/pull/1062)) |
| 207 | * Update tested WordPress version to 6.5. ([1027](https://github.com/WordPress/performance/pull/1027)) |
| 208 | |
| 209 | = 1.0.5 = |
| 210 | |
| 211 | * Exclude ".wordpress-org" directory when deploying standalone plugins. ([866](https://github.com/WordPress/performance/pull/866)) |
| 212 | |
| 213 | = 1.0.4 = |
| 214 | |
| 215 | * Bump minimum required PHP version to 7.0 and minimum required WP version to 6.3. ([851](https://github.com/WordPress/performance/pull/851)) |
| 216 | |
| 217 | = 1.0.3 = |
| 218 | |
| 219 | * Add standalone plugin assets. ([815](https://github.com/WordPress/performance/pull/815)) |
| 220 | |
| 221 | = 1.0.2 = |
| 222 | |
| 223 | * Fix WebP handling when editing images based on WordPress 6.3 change. ([796](https://github.com/WordPress/performance/pull/796)) |
| 224 | |
| 225 | = 1.0.1 = |
| 226 | |
| 227 | * Bump tested up to version to 6.3. ([772](https://github.com/WordPress/performance/pull/772)) |
| 228 | |
| 229 | = 1.0.0 = |
| 230 | |
| 231 | * Initial release of the Modern Image Formats plugin as a standalone plugin. ([664](https://github.com/WordPress/performance/pull/664)) |
| 232 | |
| 233 | == Upgrade Notice == |
| 234 | |
| 235 | = 2.0.0 = |
| 236 | |
| 237 | This release adds support for AVIF images and enables selecting the the output image format to choose between WebP and AVIF when both are available. AVIF is used as the default when the server supports it. |
| 238 |