Add preferred image format option

Author: mustafauysal

includes/classes/Admin/Dashboard.php

@@ -19,6 +19,7 @@
 use const ImageOptimizerPro\Constants\LICENSE_ENDPOINT;
 use const ImageOptimizerPro\Constants\LICENSE_INFO_TRANSIENT;
 use const ImageOptimizerPro\Constants\LICENSE_KEY_OPTION;
+use const ImageOptimizerPro\Constants\SETTING_OPTION;
 
 /**
  * Class Dashboard
@@ -116,6 +117,7 @@ public function add_menu() {
 	public function render_dashboard() {
 		$license_key  = get_license_key();
 		$license_info = get_license_info();
+		$settings     = \ImageOptimizerPro\Utils\get_settings();
 
 		if ( is_network_admin() ) {
 			settings_errors();
@@ -140,6 +142,24 @@ public function render_dashboard() {
 							<span class="description"><?php echo esc_html( get_license_status_message() ); ?></span>
 						</td>
 					</tr>
+					<tr>
+						<th scope="row">
+						</th>
+						<td>
+							<fieldset>
+								<legend class="screen-reader-text">
+									<span><?php esc_html_e( 'Use WebP over AVIF', 'image-optimizer-pro' ); ?></span>
+								</legend>
+								<label for="preferred_format">
+									<input name="preferred_format" type="checkbox" id="preferred_format" value="webp" <?php checked( 'webp', $settings['preferred_format'] ); ?>>
+									<?php esc_html_e( 'Use WebP over AVIF', 'image-optimizer-pro' ); ?>
+								</label>
+							</fieldset>
+							<span class="description">
+								<?php esc_html_e( 'Activate this option to prioritize the WebP format over AVIF for image optimization.', 'image-optimizer-pro' ); ?>
+							</span>
+						</td>
+					</tr>
 					</tbody>
 				</table>
 				<?php submit_button( esc_html__( 'Save Changes', 'image-optimizer-pro' ), 'submit primary' ); ?>
@@ -243,6 +263,9 @@ public function save_settings() {
 			return;
 		}
 
+		$settings                     = [];
+		$settings['preferred_format'] = sanitize_text_field( wp_unslash( $_POST['preferred_format'] ?? '' ) );
+
 		$license_key         = sanitize_text_field( filter_input( INPUT_POST, 'license_key' ) );
 		$current_license_key = mask_string( $license_key, 3 );
 		$old_license_key     = mask_string( get_license_key(), 3 );
@@ -255,8 +278,10 @@ public function save_settings() {
 		$encrypted_license_key = $encryption->encrypt( $license_key );
 
 		if ( IMAGE_OPTIMIZER_PRO_IS_NETWORK ) {
+			update_site_option( SETTING_OPTION, $settings );
 			update_site_option( LICENSE_KEY_OPTION, $encrypted_license_key );
 		} else {
+			update_option( SETTING_OPTION, $settings, false );
 			update_option( LICENSE_KEY_OPTION, $encrypted_license_key, false );
 		}
 

includes/classes/Optimizer.php

@@ -49,6 +49,14 @@ class Optimizer {
 	 */
 	protected static $image_sizes = null;
 
+	/**
+	 * Preferred image format.
+	 * It is used to determine the preferred image format for the current request.
+	 *
+	 * @var null
+	 */
+	protected static $preferred_image_formats = null;
+
 	/**
 	 * Singleton implementation
 	 *
@@ -107,6 +115,10 @@ private function setup() {
 			return true;
 		}
 
+		$settings = \ImageOptimizerPro\Utils\get_settings();
+		// set preferred image format
+		self::$preferred_image_formats = $settings['preferred_format'];
+
 		// skip photonized urls when image optimizer active
 		add_filter( 'jetpack_photon_skip_for_url', '__return_true' );
 		add_filter( 'wp_resource_hints', [ $this, 'add_dns_prefetch' ], 10, 2 );
@@ -1492,6 +1504,10 @@ public static function image_optimizer_url( $image_url, $args = array(), $scheme
 			$image_optimizer_url = add_query_arg( array( 'ssl' => 1 ), $image_optimizer_url );
 		}
 
+		if ( ! empty( self::$preferred_image_formats ) && 'webp' === self::$preferred_image_formats ) {
+			$image_optimizer_url = add_query_arg( array( 'format' => 'webp' ), $image_optimizer_url );
+		}
+
 		return self::url_schema( $image_optimizer_url, $scheme );
 	}
 

includes/constants.php

@@ -8,6 +8,7 @@
 namespace ImageOptimizerPro\Constants;
 
 const MENU_SLUG          = 'image-optimizer-pro';
+const SETTING_OPTION     = 'image_optimizer_pro_settings';
 const LICENSE_KEY_OPTION = 'image_optimizer_pro_license_key';
 
 // transient keys

includes/utils.php

@@ -11,6 +11,7 @@
 use const ImageOptimizerPro\Constants\LICENSE_ENDPOINT;
 use const ImageOptimizerPro\Constants\LICENSE_INFO_TRANSIENT;
 use const ImageOptimizerPro\Constants\LICENSE_KEY_OPTION;
+use const ImageOptimizerPro\Constants\SETTING_OPTION;
 
 /**
  * Is plugin activated network wide?
@@ -297,3 +298,25 @@ function is_license_active() {
 
 	return false;
 }
+
+/**
+ * Get settings with defaults
+ *
+ * @return array
+ * @since  1.0.1
+ */
+function get_settings() {
+	$defaults = [
+		'preferred_format' => '',
+	];
+
+	if ( IMAGE_OPTIMIZER_PRO_IS_NETWORK ) {
+		$settings = get_site_option( SETTING_OPTION, [] );
+	} else {
+		$settings = get_option( SETTING_OPTION, [] );
+	}
+
+	$settings = wp_parse_args( $settings, $defaults );
+
+	return $settings;
+}