<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[24369] trunk/wp-includes: Move XHR helpers from media to utils.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/24369">24369</a></dd>
<dt>Author</dt> <dd>koopersmith</dd>
<dt>Date</dt> <dd>2013-05-26 06:58:01 +0000 (Sun, 26 May 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Move XHR helpers from media to utils. See <a href="http://core.trac.wordpress.org/ticket/24424">#24424</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesjsmediamodelsjs">trunk/wp-includes/js/media-models.js</a></li>
<li><a href="#trunkwpincludesjswputiljs">trunk/wp-includes/js/wp-util.js</a></li>
<li><a href="#trunkwpincludesscriptloaderphp">trunk/wp-includes/script-loader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesjsmediamodelsjs"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/js/media-models.js (24368 => 24369)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/media-models.js 2013-05-26 06:43:13 UTC (rev 24368)
+++ trunk/wp-includes/js/media-models.js 2013-05-26 06:58:01 UTC (rev 24369)
</span><span class="lines">@@ -93,7 +93,7 @@
</span><span class="cx"> * media.template( id )
</span><span class="cx"> *
</span><span class="cx"> * Fetches a template by id.
</span><del>- * See wp.template() in `wp-includes/js/wp-backbone.js`.
</del><ins>+ * See wp.template() in `wp-includes/js/wp-util.js`.
</ins><span class="cx"> */
</span><span class="cx"> template: wp.template,
</span><span class="cx">
</span><span class="lines">@@ -101,67 +101,18 @@
</span><span class="cx"> * media.post( [action], [data] )
</span><span class="cx"> *
</span><span class="cx"> * Sends a POST request to WordPress.
</span><del>- *
- * @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.
</del><ins>+ * See wp.xhr.post() in `wp-includes/js/wp-util.js`.
</ins><span class="cx"> */
</span><del>- post: function( action, data ) {
- return media.ajax({
- data: _.isObject( action ) ? action : _.extend( data || {}, { action: action })
- });
- },
</del><ins>+ post: wp.xhr.post,
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * media.ajax( [action], [options] )
</span><span class="cx"> *
</span><del>- * 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.
</del><ins>+ * Sends an XHR request to WordPress.
+ * See wp.xhr.send() in `wp-includes/js/wp-util.js`.
</ins><span class="cx"> */
</span><del>- ajax: function( action, options ) {
- if ( _.isObject( action ) ) {
- options = action;
- } else {
- options = options || {};
- options.data = _.extend( options.data || {}, { action: action });
- }
</del><ins>+ ajax: wp.xhr.send,
</ins><span class="cx">
</span><del>- 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();
- },
-
</del><span class="cx"> // Scales a set of dimensions to fit within bounding dimensions.
</span><span class="cx"> fit: function( dimensions ) {
</span><span class="cx"> var width = dimensions.width,
</span></span></pre></div>
<a id="trunkwpincludesjswputiljs"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/js/wp-util.js (24368 => 24369)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/wp-util.js 2013-05-26 06:43:13 UTC (rev 24368)
+++ trunk/wp-includes/js/wp-util.js 2013-05-26 06:58:01 UTC (rev 24369)
</span><span class="lines">@@ -1,6 +1,9 @@
</span><span class="cx"> window.wp = window.wp || {};
</span><span class="cx">
</span><span class="cx"> (function ($) {
</span><ins>+ // Check for the utility settings.
+ var settings = typeof _wpUtilSettings === 'undefined' ? {} : _wpUtilSettings;
+
</ins><span class="cx"> /**
</span><span class="cx"> * wp.template( id )
</span><span class="cx"> *
</span><span class="lines">@@ -24,4 +27,79 @@
</span><span class="cx"> return compiled( data );
</span><span class="cx"> };
</span><span class="cx"> });
</span><ins>+
+ // 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();
+ }
+ };
+
</ins><span class="cx"> }(jQuery));
</span></span></pre></div>
<a id="trunkwpincludesscriptloaderphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/script-loader.php (24368 => 24369)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/script-loader.php 2013-05-26 06:43:13 UTC (rev 24368)
+++ trunk/wp-includes/script-loader.php 2013-05-26 06:58:01 UTC (rev 24369)
</span><span class="lines">@@ -275,6 +275,12 @@
</span><span class="cx"> $scripts->add( 'backbone', '/wp-includes/js/backbone.min.js', array('underscore','jquery'), '1.0.0', 1 );
</span><span class="cx">
</span><span class="cx"> $scripts->add( 'wp-util', "/wp-includes/js/wp-util$suffix.js", array('underscore', 'jquery'), false, 1 );
</span><ins>+ did_action( 'init' ) && $scripts->localize( 'wp-util', '_wpUtilSettings', array(
+ 'xhr' => array(
+ 'url' => admin_url( 'admin-ajax.php', 'relative' ),
+ ),
+ ) );
+
</ins><span class="cx"> $scripts->add( 'wp-backbone', "/wp-includes/js/wp-backbone$suffix.js", array('backbone', 'wp-util'), false, 1 );
</span><span class="cx">
</span><span class="cx"> $scripts->add( 'revisions', "/wp-admin/js/revisions$suffix.js", array( 'wp-backbone', 'jquery-ui-slider', 'jquery-ui-tooltip' ), false, 1 );
</span></span></pre>
</div>
</div>
</body>
</html>