Skip to content

refactor: default settings for compression #975

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Oct 6, 2025
Merged

refactor: default settings for compression #975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0823ba9
refactor: default settings for compression
RaduCristianPopescu Sep 30, 2025
aef2b20
chore: fix tests
RaduCristianPopescu Sep 30, 2025
776792a
chore: phpcs
RaduCristianPopescu Sep 30, 2025
3db479b
chore: enable Best Format and AVIF by default
Soare-Robert-Daniel Oct 3, 2025
b08acd8
chore: update tests for `f:best`
Soare-Robert-Daniel Oct 3, 2025
d2b6546
Remove new avif filter since we already have one.
selul Oct 6, 2025
72b0f72
refactor: clean up whitespace in Compression.js
selul Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 2 additions & 19 deletions assets/src/dashboard/parts/connected/settings/Compression.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ const Compression = ({

const isNetworkOptimizationEnabled = 'disabled' !== settings[ 'network_optimization' ];
const isCDNEnabled = 'disabled' !== settings.cdn;
const isAVIFEnabled = 'disabled' !== settings.avif;
const isStripMetadataEnabled = 'disabled' !== settings[ 'strip_metadata' ];
const isAutoQualityEnabled = 'disabled' !== settings.autoquality;
const isBestFormatEnabled = 'disabled' !== settings[ 'best_format' ];
Expand Down Expand Up @@ -140,10 +139,10 @@ const Compression = ({
setCanSave( true );
const data = { ...settings };
if ( 'speed_optimized' === value ) {
data[ 'best_format' ] = 'disabled';
data[ 'best_format' ] = 'enabled';
data[ 'retina_images' ] = 'disabled';
data[ 'network_optimization' ] = 'enabled';
data.avif = 'mauto';
data.avif = 'enabled';
data.autoquality = 'enabled';
data[ 'strip_metadata' ] = 'enabled';
}
Expand All @@ -160,7 +159,6 @@ const Compression = ({
data[ 'best_format' ] = ( customSettings.best_format ?? isBestFormatEnabled ) ? 'enabled' : 'disabled';
data[ 'retina_images' ] = ( customSettings.retina_images ?? isRetinaEnabled ) ? 'enabled' : 'disabled';
data[ 'network_optimization' ] = ( customSettings.network_optimization ?? isNetworkOptimizationEnabled ) ? 'enabled' : 'disabled';
data.avif = ( customSettings.avif ?? isAVIFEnabled ) ? 'enabled' : 'disabled';
data.autoquality = ( customSettings.autoquality ?? isAutoQualityEnabled ) ? 'enabled' : 'disabled';
data[ 'strip_metadata' ] = ( customSettings.strip_metadata ?? isStripMetadataEnabled ) ? 'enabled' : 'disabled';
}
Expand Down Expand Up @@ -280,21 +278,6 @@ const Compression = ({
<hr className="my-8 border-grayish-blue"/>


<ToggleControl
label={ optimoleDashboardApp.strings.options_strings.enable_avif_title }
help={ () => <p dangerouslySetInnerHTML={ { __html: optimoleDashboardApp.strings.options_strings.enable_avif_desc } } /> }
checked={ isAVIFEnabled }
disabled={ isLoading }
className={ classnames(
{
'is-disabled': isLoading
}
) }
onChange={ value => updateOption( 'avif', value ) }
/>

<hr className="my-8 border-grayish-blue"/>

<ToggleControl
label={ optimoleDashboardApp.strings.options_strings.strip_meta_title }
help={ () => <p dangerouslySetInnerHTML={ { __html: optimoleDashboardApp.strings.options_strings.strip_meta_desc } } /> }
Expand Down
6 changes: 2 additions & 4 deletions inc/admin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,9 +391,7 @@ public function update_default_settings() {

$this->settings->update( 'limit_dimensions', 'enabled' );
$this->settings->update( 'lazyload', 'enabled' );
$this->settings->update( 'best_format', 'disabled' );
$this->settings->update( 'skip_lazyload_images', '2' );
$this->settings->update( 'avif', 'disabled' );
$this->settings->update( 'compression_mode', 'speed_optimized' );

update_option( self::NEW_USER_DEFAULTS_UPDATED, 'yes' );
Expand Down Expand Up @@ -1720,7 +1718,7 @@ private function get_dashboard_strings() {
'best_format_title' => __( 'Automatic Best Image Format Selection', 'optimole-wp' ),
'best_format_desc' => sprintf(
/* translators: 1 is the starting anchor tag, 2 is the ending anchor tag */
__( 'When enabled, Optimole picks the ideal format for your images, balancing quality and speed. It tests different formats, like AVIF and WebP, ensuring images look good and load quickly. %1$sLearn more%2$s.', 'optimole-wp' ),
__( 'When enabled, Optimole chooses the best format for your images, balancing quality with speed. It tries options like AVIF and WebP to keep visuals sharp and pages fast, though uncached images may take a bit longer to process. %1$sLearn more%2$s.', 'optimole-wp' ),
'<a class="inline-block text-purple-gray underline" target=”_blank” href="https://docs.optimole.com/article/1942-best-format">',
'</a>'
),
Expand Down Expand Up @@ -1826,7 +1824,7 @@ private function get_dashboard_strings() {
'enable_resize_smart_title' => __( 'Smart Cropping', 'optimole-wp' ),
'enable_retina_desc' => sprintf(
/* translators: 1 is the starting anchor tag, 2 is the ending anchor tag */
__( 'Enable this feature to optimize your images for Retina displays. Retina-ready images are optimized to look sharp on screens with higher pixel density, offering viewers enhanced visual quality. %1$sLearn more%2$s', 'optimole-wp' ),
__( 'Optimizes images for Retina (high-DPI) screens for sharper results. Always enabled for images under 150px wide. %1$sLearn more%2$s', 'optimole-wp' ),
'<a class="inline-block text-purple-gray underline" target=”_blank” href="https://docs.optimole.com/article/1391-what-is-a-retina-image">',
'</a>'
),
Expand Down
2 changes: 1 addition & 1 deletion inc/settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ class Optml_Settings {
'img_to_video' => 'disabled',
'css_minify' => 'enabled',
'js_minify' => 'disabled',
'avif' => 'enabled',
'avif' => 'enabled', // legacy setting, is no longer used in the UI
'autoquality' => 'enabled',
'native_lazyload' => 'disabled',
'offload_media' => 'disabled',
Expand Down
16 changes: 16 additions & 0 deletions inc/url_replacer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,22 @@ private function normalize_image( $url, $original_url, $args, $is_uploaded = fal
$args['resize']['gravity'] = GravityProperty::SMART;
}

$is_retina_enabled = $this->settings->get( 'retina_images' ) !== 'disabled';
if ( ! $is_retina_enabled ) {
$max_dimension = max( $args['width'], $args['height'] );
$should_apply_dpr = false;

if ( $max_dimension > 0 && $max_dimension < 150 ) {
$should_apply_dpr = true;
}

$should_apply_dpr = apply_filters( 'optml_should_apply_dpr', $should_apply_dpr, $args, $url );

if ( $should_apply_dpr && ! isset( $args['dpr'] ) ) {
$args['dpr'] = 2;
}
}

$args = apply_filters( 'optml_image_args', $args, $original_url );
$image = Optimole::image( apply_filters( 'optml_processed_url', $url ), self::get_active_cache_booster( $url, $this->active_cache_buster ) );

Expand Down
6 changes: 3 additions & 3 deletions tests/test-lazyload.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ public function test_lazy_load_preserve_image_size() {
$this->assertNotEquals( $replaced_content, $html );
$this->assertStringNotContainsString( 'q:eco/rt:fill/g:ce', $replaced_content );
$this->assertStringContainsString( '/rt:fill/g:ce', $replaced_content );
$this->assertStringContainsString( '/w:96/h:96/q:eco/ig:avif/http://example.org/', $replaced_content );
$this->assertStringContainsString( '/w:96/h:96/q:eco/f:best/dpr:2/http://example.org/', $replaced_content );

}

Expand All @@ -248,7 +248,7 @@ public function test_width_100() {

$replaced_content = Optml_Manager::instance()->replace_content( $content );

$this->assertEquals( '<img decoding=async data-opt-id=1786304581 data-opt-src="https://test123.i.optimole.com/w:auto/h:auto/q:mauto/ig:avif/http://example.org/wp-content/uploads/2018/11/gradient.png" height="100%" src="https://test123.i.optimole.com/w:auto/h:auto/q:eco/ig:avif/http://example.org/wp-content/uploads/2018/11/gradient.png" class="at0px" width="100%"/><noscript><img decoding=async data-opt-id=1786304581 height="100%" src="https://test123.i.optimole.com/w:auto/h:auto/q:mauto/ig:avif/http://example.org/wp-content/uploads/2018/11/gradient.png" class="at0px" width="100%"/></noscript>', $replaced_content );
$this->assertEquals( '<img decoding=async data-opt-id=1786304581 data-opt-src="https://test123.i.optimole.com/w:auto/h:auto/q:mauto/f:best/http://example.org/wp-content/uploads/2018/11/gradient.png" height="100%" src="https://test123.i.optimole.com/w:auto/h:auto/q:eco/f:best/http://example.org/wp-content/uploads/2018/11/gradient.png" class="at0px" width="100%"/><noscript><img decoding=async data-opt-id=1786304581 height="100%" src="https://test123.i.optimole.com/w:auto/h:auto/q:mauto/f:best/http://example.org/wp-content/uploads/2018/11/gradient.png" class="at0px" width="100%"/></noscript>', $replaced_content );

}
public function test_check_with_no_script() {
Expand Down Expand Up @@ -542,7 +542,7 @@ public function test_generic_placeholder() {

public function test_dam_lazyloading() {
$replaced_content = Optml_Manager::instance()->process_images_from_content( self::DAM_IMG_TAG );
$this->assertStringContainsString( 'data-opt-src="https://cloudUrlTest.test/w:100/h:200/rt:fill/g:ce/ig:avif/q:mauto/id:b1b12ee03bf3945d9d9bb963ce79cd4f/https://test-site.test/9.jpg"', $replaced_content );
$this->assertStringContainsString( 'data-opt-src="https://cloudUrlTest.test/w:100/h:200/rt:fill/g:ce/f:best/q:mauto/id:b1b12ee03bf3945d9d9bb963ce79cd4f/https://test-site.test/9.jpg"', $replaced_content );
}
public function test_dam_lazyloading_no_wh_attributes() {
add_filter('optml_lazyload_images_skip','__return_zero');
Expand Down
2 changes: 1 addition & 1 deletion tests/test-replacer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ public function test_assets_url() {
$this->assertStringContainsString( 'https://test123.i.optimole.com/cb:eFRn.20eff/f:js/q:mauto/m:0/http://example.org/wp-content/plugins/divi-bars/assets/js/snap.svg-min.js', $replaced_content );
$this->assertStringContainsString( 'https://test123.i.optimole.com/cb:eFRn.20eff/f:css/q:mauto/m:1/http://example.org/wp-includes/js/hoverintent-js.min.png-random.css', $replaced_content );
$this->assertStringContainsString( 'https://test123.i.optimole.com/cb:eFRn.20eff/f:js/q:mauto/m:0/http://example.org/wp-includes/js/assets/whatever.jpg.png.css.js', $replaced_content );
$this->assertStringContainsString( 'https://test123.i.optimole.com/cb:eFRn.20eff/w:auto/h:auto/q:mauto/ig:avif/https://example.org/wp-includes/js/assets/whatever.jpg.jpg', $replaced_content );
$this->assertStringContainsString( 'https://test123.i.optimole.com/cb:eFRn.20eff/w:auto/h:auto/q:mauto/f:best/https://example.org/wp-includes/js/assets/whatever.jpg.jpg', $replaced_content );

$settings = new Optml_Settings();
$settings->update( 'css_minify', 'disabled' );
Expand Down
Loading