Changeset 24369

Timestamp:

05/26/2013 06:58:01 AM (13 years ago)

Author:

koopersmith

Message:

Move XHR helpers from media to utils. See #24424.

Location:

trunk/wp-includes

Files:

• js/media-models.js (modified) (2 diffs)
• js/wp-util.js (modified) (2 diffs)
• script-loader.php (modified) (1 diff)

trunk/wp-includes/js/media-models.js

@@ -94 +94 @@
          *
          * Fetches a template by id.
-         * See wp.template() in `wp-includes/js/wp-backbone.js`.
+         * See wp.template() in `wp-includes/js/wp-util.js`.
          */
         template: wp.template,
@@ -102 +102 @@
          *
          * Sends a POST request to WordPress.
-         *
-         * @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.
+         * See wp.xhr.post() in `wp-includes/js/wp-util.js`.
          */
-        post: function( action, data ) {
-            return media.ajax({
-                data: _.isObject( action ) ? action : _.extend( data || {}, { action: action })
-            });
-        },
+        post: wp.xhr.post,
 
         /**
          * media.ajax( [action], [options] )
          *
-         * Sends a POST request to WordPress.
-         *
-         * @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.
+         * Sends an XHR request to WordPress.
+         * See wp.xhr.send() in `wp-includes/js/wp-util.js`.
          */
-        ajax: function( action, options ) {
-            if ( _.isObject( action ) ) {
-                options = action;
-            } else {
-                options = options || {};
-                options.data = _.extend( options.data || {}, { action: action });
-            }
-
-            options = _.defaults( options || {}, {
-                type:    'POST',
-                url:     media.model.settings.ajaxurl,
-                context: this
-            });
-
-            return $.Deferred( function( deferred ) {
-                // Transfer success/error callbacks.
-                if ( options.success )
-                    deferred.done( options.success );
-                if ( options.error )
-                    deferred.fail( options.error );
-
-                delete options.success;
-                delete options.error;
-
-                // Use with PHP's wp_send_json_success() and wp_send_json_error()
-                $.ajax( options ).done( function( response ) {
-                    // Treat a response of `1` as successful for backwards
-                    // compatibility with existing handlers.
-                    if ( response === '1' || response === 1 )
-                        response = { success: true };
-
-                    if ( _.isObject( response ) && ! _.isUndefined( response.success ) )
-                        deferred[ response.success ? 'resolveWith' : 'rejectWith' ]( this, [response.data] );
-                    else
-                        deferred.rejectWith( this, [response] );
-                }).fail( function() {
-                    deferred.rejectWith( this, arguments );
-                });
-            }).promise();
-        },
+        ajax: wp.xhr.send,
 
         // Scales a set of dimensions to fit within bounding dimensions.

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

@@ -2 +2 @@
 
 (function ($) {
+    // Check for the utility settings.
+    var settings = typeof _wpUtilSettings === 'undefined' ? {} : _wpUtilSettings;
+
     /**
      * wp.template( id )
@@ -25 +28 @@
         };
     });
+
+    // wp.xhr
+    // ------
+    //
+    // Tools for sending ajax requests with JSON responses and built in error handling.
+    // Mirrors and wraps jQuery's ajax APIs.
+    wp.xhr = {
+        settings: settings.xhr || {},
+
+        /**
+         * wp.xhr.post( [action], [data] )
+         *
+         * Sends a POST request to WordPress.
+         *
+         * @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.
+         */
+        post: function( action, data ) {
+            return wp.xhr.send({
+                data: _.isObject( action ) ? action : _.extend( data || {}, { action: action })
+            });
+        },
+
+        /**
+         * wp.xhr.send( [action], [options] )
+         *
+         * Sends a POST request to WordPress.
+         *
+         * @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.
+         */
+        send: function( action, options ) {
+            if ( _.isObject( action ) ) {
+                options = action;
+            } else {
+                options = options || {};
+                options.data = _.extend( options.data || {}, { action: action });
+            }
+
+            options = _.defaults( options || {}, {
+                type:    'POST',
+                url:     wp.xhr.settings.url,
+                context: this
+            });
+
+            return $.Deferred( function( deferred ) {
+                // Transfer success/error callbacks.
+                if ( options.success )
+                    deferred.done( options.success );
+                if ( options.error )
+                    deferred.fail( options.error );
+
+                delete options.success;
+                delete options.error;
+
+                // Use with PHP's wp_send_json_success() and wp_send_json_error()
+                $.ajax( options ).done( function( response ) {
+                    // Treat a response of `1` as successful for backwards
+                    // compatibility with existing handlers.
+                    if ( response === '1' || response === 1 )
+                        response = { success: true };
+
+                    if ( _.isObject( response ) && ! _.isUndefined( response.success ) )
+                        deferred[ response.success ? 'resolveWith' : 'rejectWith' ]( this, [response.data] );
+                    else
+                        deferred.rejectWith( this, [response] );
+                }).fail( function() {
+                    deferred.rejectWith( this, arguments );
+                });
+            }).promise();
+        }
+    };
+
 }(jQuery));

trunk/wp-includes/script-loader.php

@@ -276 +276 @@
 
     $scripts->add( 'wp-util', "/wp-includes/js/wp-util$suffix.js", array('underscore', 'jquery'), false, 1 );
+    did_action( 'init' ) && $scripts->localize( 'wp-util', '_wpUtilSettings', array(
+        'xhr' => array(
+            'url' => admin_url( 'admin-ajax.php', 'relative' ),
+        ),
+    ) );
+
     $scripts->add( 'wp-backbone', "/wp-includes/js/wp-backbone$suffix.js", array('backbone', 'wp-util'), false, 1 );