wp/wp-includes/js/wp-util.js
author ymh <ymh.work@gmail.com>
Tue, 09 Jun 2015 03:35:32 +0200
changeset 5 5e2f62d02dcd
parent 0 d970ebf37754
child 7 cf61fcea0001
permissions -rw-r--r--
upgrade wordpress + plugins
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5
5e2f62d02dcd upgrade wordpress + plugins
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
     1
/* global _wpUtilSettings */
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
window.wp = window.wp || {};
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
(function ($) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
	// Check for the utility settings.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
	var settings = typeof _wpUtilSettings === 'undefined' ? {} : _wpUtilSettings;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
	 * wp.template( id )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
	 *
5
5e2f62d02dcd upgrade wordpress + plugins
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    11
	 * Fetch a JavaScript template for an id, and return a templating function for it.
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
	 * @param  {string} id   A string that corresponds to a DOM element with an id prefixed with "tmpl-".
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
	 *                       For example, "attachment" maps to "tmpl-attachment".
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
	 * @return {function}    A function that lazily-compiles the template requested.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
	wp.template = _.memoize(function ( id ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
		var compiled,
5
5e2f62d02dcd upgrade wordpress + plugins
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    19
			/*
5e2f62d02dcd upgrade wordpress + plugins
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    20
			 * Underscore's default ERB-style templates are incompatible with PHP
5e2f62d02dcd upgrade wordpress + plugins
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    21
			 * when asp_tags is enabled, so WordPress uses Mustache-inspired templating syntax.
5e2f62d02dcd upgrade wordpress + plugins
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    22
			 *
5e2f62d02dcd upgrade wordpress + plugins
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    23
			 * @see trac ticket #22344.
5e2f62d02dcd upgrade wordpress + plugins
ymh <ymh.work@gmail.com>
parents: 0
diff changeset
    24
			 */
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
			options = {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
				evaluate:    /<#([\s\S]+?)#>/g,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
				interpolate: /\{\{\{([\s\S]+?)\}\}\}/g,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
				escape:      /\{\{([^\}]+?)\}\}(?!\})/g,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
				variable:    'data'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
			};
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
		return function ( data ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
			compiled = compiled || _.template( $( '#tmpl-' + id ).html(), null, options );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
			return compiled( data );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
		};
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
	});
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
	// wp.ajax
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
	// ------
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
	//
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
	// Tools for sending ajax requests with JSON responses and built in error handling.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
	// Mirrors and wraps jQuery's ajax APIs.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
	wp.ajax = {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
		settings: settings.ajax || {},
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
		/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
		 * wp.ajax.post( [action], [data] )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
		 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
		 * Sends a POST request to WordPress.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
		 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
		 * @param  {string} action The slug of the action to fire in WordPress.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
		 * @param  {object} data   The data to populate $_POST with.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
		 * @return {$.promise}     A jQuery promise that represents the request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
		 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
		post: function( action, data ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
			return wp.ajax.send({
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
				data: _.isObject( action ) ? action : _.extend( data || {}, { action: action })
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
			});
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
		},
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
		/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
		 * wp.ajax.send( [action], [options] )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
		 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
		 * Sends a POST request to WordPress.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
		 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
		 * @param  {string} action  The slug of the action to fire in WordPress.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
		 * @param  {object} options The options passed to jQuery.ajax.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
		 * @return {$.promise}      A jQuery promise that represents the request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
		 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
		send: function( action, options ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
			if ( _.isObject( action ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
				options = action;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
			} else {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
				options = options || {};
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
				options.data = _.extend( options.data || {}, { action: action });
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
			}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
			options = _.defaults( options || {}, {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
				type:    'POST',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
				url:     wp.ajax.settings.url,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
				context: this
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
			});
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
			return $.Deferred( function( deferred ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
				// Transfer success/error callbacks.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
				if ( options.success )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
					deferred.done( options.success );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
				if ( options.error )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
					deferred.fail( options.error );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
				delete options.success;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
				delete options.error;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
				// Use with PHP's wp_send_json_success() and wp_send_json_error()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
				$.ajax( options ).done( function( response ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
					// Treat a response of `1` as successful for backwards
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
					// compatibility with existing handlers.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
					if ( response === '1' || response === 1 )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
						response = { success: true };
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
					if ( _.isObject( response ) && ! _.isUndefined( response.success ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
						deferred[ response.success ? 'resolveWith' : 'rejectWith' ]( this, [response.data] );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
					else
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
						deferred.rejectWith( this, [response] );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
				}).fail( function() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
					deferred.rejectWith( this, arguments );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
				});
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
			}).promise();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
	};
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
}(jQuery));