Changeset 57024

Timestamp:

10/27/2023 08:05:57 PM (9 months ago)

Author:

joedolson

Message:

Plugins: Prevent ajaxComplete listener from observing all events.

Add a conditional to prevent the prefers-reduced-motion ajaxComplete listener from observing events not occurring in the plugin installation screen. Improve handling of settings data test.

The listener observing ajaxComplete in [56541] was intercepting all ajaxComplete events, creating potential for unexpected errors in unrelated functions.

Props bplv, afercia, rudlinkon, hellofromTonya, huzaifaalmesbah, joedolson, jorbin.
Reviewed by jorbin.
Merges [57022] to the 6.4 branch.
Fixes #59689.

Location:

branches/6.4

Files:

• . (modified) (1 prop)
• src/js/_enqueues/admin/common.js (modified) (3 diffs)

branches/6.4/src/js/_enqueues/admin/common.js

@@ -2130 +2130 @@
  * Freeze animated plugin icons when reduced motion is enabled.
  *
- * When the user has enabled the 'prefers-reduced-motion' setting, this module 
- * stops animations for all GIFs on the page with the class 'plugin-icon' or 
+ * When the user has enabled the 'prefers-reduced-motion' setting, this module
+ * stops animations for all GIFs on the page with the class 'plugin-icon' or
  * plugin icon images in the update plugins table.
  *
@@ -2157 +2157 @@
             var height = img.height;
             var canvas = document.createElement( 'canvas' );
-            
+
             // Set canvas dimensions.
             canvas.width = width;
@@ -2220 +2220 @@
     // Listen for jQuery AJAX events.
     ( function( $ ) {
-        $( document ).ajaxComplete( function( event, xhr, settings ) {
-            // Check if this is the 'search-install-plugins' request.
-            if ( settings.data && settings.data.includes( 'action=search-install-plugins' ) ) {
-                // Recheck if the user prefers reduced motion.
-                if ( window.matchMedia ) {
-                    var mediaQuery = window.matchMedia( '(prefers-reduced-motion: reduce)' );
-                    if ( mediaQuery.matches ) {
-                        pub.freezeAll();
-                    }
-                } else {
-                    // Fallback for browsers that don't support matchMedia.
-                    if ( true === priv.pauseAll ) {
-                        pub.freezeAll();
+        if ( window.pagenow === 'plugin-install' ) {
+            // Only listen for ajaxComplete if this is the plugin-install.php page.
+            $( document ).ajaxComplete( function( event, xhr, settings ) {
+
+                // Check if this is the 'search-install-plugins' request.
+                if ( settings.data && typeof settings.data === 'string' && settings.data.includes( 'action=search-install-plugins' ) ) {
+                    // Recheck if the user prefers reduced motion.
+                    if ( window.matchMedia ) {
+                        var mediaQuery = window.matchMedia( '(prefers-reduced-motion: reduce)' );
+                        if ( mediaQuery.matches ) {
+                            pub.freezeAll();
+                        }
+                    } else {
+                        // Fallback for browsers that don't support matchMedia.
+                        if ( true === priv.pauseAll ) {
+                            pub.freezeAll();
+                        }
                     }
                 }
-            }
-        } );
+            }
+        }
     } )( jQuery );