Changeset 38293

Timestamp:

08/20/2016 10:58:34 PM (9 years ago)

Author:

wonderboymusic

Message:

Media: Add some docs to media-gallery.js RIP.

Props jipmoors.
Fixes #37717.

File:

• trunk/src/wp-admin/js/media-gallery.js (modified) (1 diff)

trunk/src/wp-admin/js/media-gallery.js

@@ -1 +1 @@
 /* global ajaxurl */
-jQuery(function($){
-    $( 'body' ).bind( 'click.wp-gallery', function(e){
+
+/**
+ * This file is used on media-upload.php which has been replaced by media-new.php and upload.php
+ * Deprecated since 3.5.0
+ */
+jQuery(function($) {
+    /**
+     * Adds a click event handler to the element with a 'wp-gallery' class.
+     */
+    $( 'body' ).bind( 'click.wp-gallery', function(e) {
         var target = $( e.target ), id, img_size;
 
         if ( target.hasClass( 'wp-set-header' ) ) {
+            // Opens the image to preview it full size.
             ( window.dialogArguments || opener || parent || top ).location.href = target.data( 'location' );
             e.preventDefault();
         } else if ( target.hasClass( 'wp-set-background' ) ) {
+            // Sets the image as background of the theme.
             id = target.data( 'attachment-id' );
             img_size = $( 'input[name="attachments[' + id + '][image-size]"]:checked').val();
 
+            /**
+             * This AJAX action has been deprecated since 3.5.0, see custom-background.php
+             */
             jQuery.post(ajaxurl, {
                 action: 'set-background-image',
                 attachment_id: id,
                 size: img_size
-            }, function(){
+            }, function() {
                 var win = window.dialogArguments || opener || parent || top;
                 win.tb_remove();