Changeset 32747

Timestamp:

06/13/2015 02:29:42 PM (8 years ago)

Author:

wonderboymusic

Message:

Add an abort class method to the Promise instance returned by wp.ajax.send().

Props westonruter.
Fixes #32628.

File:

• trunk/src/wp-includes/js/wp-util.js (modified) (5 diffs)

trunk/src/wp-includes/js/wp-util.js

@@ -51 +51 @@
          * @param  {string} action The slug of the action to fire in WordPress.
          * @param  {object} data   The data to populate $_POST with.
-         * @return {$.promise}     A jQuery promise that represents the request.
+         * @return {$.promise}     A jQuery promise that represents the request,
+         *                         decorated with an abort() method.
          */
         post: function( action, data ) {
@@ -66 +67 @@
          * @param  {string} action  The slug of the action to fire in WordPress.
          * @param  {object} options The options passed to jQuery.ajax.
-         * @return {$.promise}      A jQuery promise that represents the request.
+         * @return {$.promise}      A jQuery promise that represents the request,
+         *                          decorated with an abort() method.
          */
         send: function( action, options ) {
+            var promise, deferred;
             if ( _.isObject( action ) ) {
                 options = action;
@@ -82 +85 @@
             });
 
-            return $.Deferred( function( deferred ) {
+            deferred = $.Deferred( function( deferred ) {
                 // Transfer success/error callbacks.
                 if ( options.success )
@@ -93 +96 @@
 
                 // Use with PHP's wp_send_json_success() and wp_send_json_error()
-                $.ajax( options ).done( function( response ) {
+                deferred.jqXHR = $.ajax( options ).done( function( response ) {
                     // Treat a response of `1` as successful for backwards
                     // compatibility with existing handlers.
@@ -106 +109 @@
                     deferred.rejectWith( this, arguments );
                 });
-            }).promise();
+            });
+
+            promise = deferred.promise();
+            promise.abort = function() {
+                deferred.jqXHR.abort();
+                return this;
+            };
+
+            return promise;
         }
     };