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