<!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>[42426] trunk/src/wp-admin/js/media-upload.js: Docs: Improve JSDoc for `js/media-upload.js`.</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/42426">42426</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/42426","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>atimmer</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-01-04 14:36:13 +0000 (Thu, 04 Jan 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve JSDoc for `js/media-upload.js`.
Props terwdan, diedeexterkate, andizer, ireneyoast.
Fixes <a href="https://core.trac.wordpress.org/ticket/42956">#42956</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjsmediauploadjs">trunk/src/wp-admin/js/media-upload.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjsmediauploadjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/media-upload.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/media-upload.js 2018-01-02 18:10:26 UTC (rev 42425)
+++ trunk/src/wp-admin/js/media-upload.js 2018-01-04 14:36:13 UTC (rev 42426)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,13 +1,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /* global tinymce, QTags */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// send html to the post editor
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Contains global functions for the media upload within the post edit screen.
+ *
+ * Updates the ThickBox anchor href and the ThickBox's own properties in order
+ * to set the size and position on every resize event. Also adds a function to
+ * send HTML or text to the currently active editor.
+ *
+ * @file
+ * @since 2.5.0
+ *
+ * @requires jQuery
+ */
+
</ins><span class="cx" style="display: block; padding: 0 10px"> var wpActiveEditor, send_to_editor;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Sends the HTML passed in the parameters to TinyMCE.
+ *
+ * @since 2.5.0
+ *
+ * @global
+ *
+ * @param {string} html The HTML to be sent to the editor.
+ * @returns {void|boolean} Returns false when both TinyMCE and QTags instances
+ * are unavailable. This means that the HTML was not
+ * sent to the editor.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> send_to_editor = function( html ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var editor,
</span><span class="cx" style="display: block; padding: 0 10px"> hasTinymce = typeof tinymce !== 'undefined',
</span><span class="cx" style="display: block; padding: 0 10px"> hasQuicktags = typeof QTags !== 'undefined';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If no active editor is set, try to set it.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! wpActiveEditor ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( hasTinymce && tinymce.activeEditor ) {
</span><span class="cx" style="display: block; padding: 0 10px"> editor = tinymce.activeEditor;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,23 +44,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> editor = tinymce.get( wpActiveEditor );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If the editor is set and not hidden, insert the HTML into the content of the
+ // editor.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( editor && ! editor.isHidden() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> editor.execCommand( 'mceInsertContent', false, html );
</span><span class="cx" style="display: block; padding: 0 10px"> } else if ( hasQuicktags ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If quick tags are available, insert the HTML into its content.
</ins><span class="cx" style="display: block; padding: 0 10px"> QTags.insertContent( html );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If neither the TinyMCE editor and the quick tags are available, add the HTML
+ // to the current active editor.
</ins><span class="cx" style="display: block; padding: 0 10px"> document.getElementById( wpActiveEditor ).value += html;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If the old thickbox remove function exists, call it
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If the old thickbox remove function exists, call it.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( window.tb_remove ) {
</span><span class="cx" style="display: block; padding: 0 10px"> try { window.tb_remove(); } catch( e ) {}
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// thickbox settings
</del><span class="cx" style="display: block; padding: 0 10px"> var tb_position;
</span><span class="cx" style="display: block; padding: 0 10px"> (function($) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Recalculates and applies the new ThickBox position based on the current
+ * window size.
+ *
+ * @since 2.6.0
+ *
+ * @global
+ *
+ * @returns {Object[]} Array containing jQuery objects for all the found
+ * ThickBox anchors.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> tb_position = function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var tbWindow = $('#TB_window'),
</span><span class="cx" style="display: block; padding: 0 10px"> width = $(window).width(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -55,6 +95,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> tbWindow.css({'top': 20 + adminbar_height + 'px', 'margin-top': '0'});
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Recalculates the new height and width for all links with a ThickBox class.
+ *
+ * @since 2.6.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return $('a.thickbox').each( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var href = $(this).attr('href');
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! href ) return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,6 +109,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add handler to recalculates the ThickBox position when the window is resized.
</ins><span class="cx" style="display: block; padding: 0 10px"> $(window).resize(function(){ tb_position(); });
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> })(jQuery);
</span></span></pre>
</div>
</div>
</body>
</html>