<!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>[40915] trunk/src/wp-admin/js/media.js: Docs: Add `wp-admin/js/media.js` documentation.</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/40915">40915</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/40915","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-06-15 15:36:20 +0000 (Thu, 15 Jun 2017)</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: Add `wp-admin/js/media.js` documentation.
Props jipmoors, jjcomack, diedeexterkate.
Fixes <a href="https://core.trac.wordpress.org/ticket/41072">#41072</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjsmediajs">trunk/src/wp-admin/js/media.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjsmediajs"></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.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/media.js 2017-06-15 13:23:22 UTC (rev 40914)
+++ trunk/src/wp-admin/js/media.js 2017-06-15 15:36:20 UTC (rev 40915)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,8 +1,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /* global ajaxurl, attachMediaBoxL10n, _wpMediaGridSettings, showNotice */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * @summary Creates a dialog containing posts that can have a particular media attached to it.
+ *
+ * @since 2.7.0
+ *
+ * @global
+ * @namespace
+ *
+ * @requires jQuery
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> var findPosts;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> ( function( $ ){
</span><span class="cx" style="display: block; padding: 0 10px"> findPosts = {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @summary Opens a dialog to attach media to a post.
+ *
+ * Adds an overlay prior to retrieving a list of posts to attach the media to.
+ *
+ * @since 2.7.0
+ *
+ * @memberOf findPosts
+ *
+ * @param {string} af_name The name of the affected element.
+ * @param {string} af_val The value of the affected post element.
+ *
+ * @returns {boolean} Always returns false.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> open: function( af_name, af_val ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var overlay = $( '.ui-find-overlay' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -14,35 +39,67 @@
</span><span class="cx" style="display: block; padding: 0 10px"> overlay.show();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( af_name && af_val ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // #affected is a hidden input field in the dialog that keeps track of which media should be attached.
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '#affected' ).attr( 'name', af_name ).val( af_val );
</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"> $( '#find-posts' ).show();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Close the dialog when the escape key is pressed.
</ins><span class="cx" style="display: block; padding: 0 10px"> $('#find-posts-input').focus().keyup( function( event ){
</span><span class="cx" style="display: block; padding: 0 10px"> if ( event.which == 27 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> findPosts.close();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } // close on Escape
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><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">- // Pull some results up by default
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Retrieves a list of applicable posts for media attachment and shows them.
</ins><span class="cx" style="display: block; padding: 0 10px"> findPosts.send();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+ /**
+ * @summary Clears the found posts lists before hiding the attach media dialog.
+ *
+ * @since 2.7.0
+ *
+ * @memberOf findPosts
+ *
+ * @returns {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> close: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> $('#find-posts-response').empty();
</span><span class="cx" style="display: block; padding: 0 10px"> $('#find-posts').hide();
</span><span class="cx" style="display: block; padding: 0 10px"> $( '.ui-find-overlay' ).hide();
</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">+ /**
+ * @summary Binds a click event listener to the overlay which closes the attach media dialog.
+ *
+ * @since 3.5.0
+ *
+ * @memberOf findPosts
+ *
+ * @returns {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> overlay: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> $( '.ui-find-overlay' ).on( 'click', function () {
</span><span class="cx" style="display: block; padding: 0 10px"> findPosts.close();
</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">+ /**
+ * @summary Retrieves and displays posts based on the search term.
+ *
+ * Sends a post request to the admin_ajax.php, requesting posts based on the search term provided by the user.
+ * Defaults to all posts if no search term is provided.
+ *
+ * @since 2.7.0
+ *
+ * @memberOf findPosts
+ *
+ * @returns {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> send: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var post = {
</span><span class="cx" style="display: block; padding: 0 10px"> ps: $( '#find-posts-input' ).val(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -53,6 +110,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> spinner.addClass( 'is-active' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Send a POST request to admin_ajax.php, hide the spinner and replace the list of posts with the response data.
+ * If an error occurs, display it.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $.ajax( ajaxurl, {
</span><span class="cx" style="display: block; padding: 0 10px"> type: 'POST',
</span><span class="cx" style="display: block; padding: 0 10px"> data: post,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -71,10 +132,15 @@
</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">+ /**
+ * @summary Initializes the file once the DOM is fully loaded and attaches events to the various form elements.
+ *
+ * @returns {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $( document ).ready( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var settings, $mediaGridWrap = $( '#wp-media-grid' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Open up a manage media frame into the grid.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Opens a manage media frame into the grid.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $mediaGridWrap.length && window.wp && window.wp.media ) {
</span><span class="cx" style="display: block; padding: 0 10px"> settings = _wpMediaGridSettings;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,19 +151,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }).open();
</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">+ // Prevents form submission if no post has been selected.
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '#find-posts-submit' ).click( function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $( '#find-posts-response input[type="radio"]:checked' ).length )
</span><span class="cx" style="display: block; padding: 0 10px"> event.preventDefault();
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Submits the search query when hitting the enter key in the search input.
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '#find-posts .find-box-search :input' ).keypress( function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 13 == event.which ) {
</span><span class="cx" style="display: block; padding: 0 10px"> findPosts.send();
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+
+ // Binds the click event to the search button.
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '#find-posts-search' ).click( findPosts.send );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Binds the close dialog click event.
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '#find-posts-close' ).click( findPosts.close );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Binds the bulk action events to the submit buttons.
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '#doaction, #doaction2' ).click( function( event ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /*
+ * Retrieves all select elements for bulk actions that have a name starting with `action`
+ * and handle its action based on its value.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $( 'select[name^="action"]' ).each( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var optionValue = $( this ).val();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -112,7 +192,11 @@
</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">- // Enable whole row to be clicked
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @summary Enables clicking on the entire table row.
+ *
+ * @returns {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $( '.find-box-inside' ).on( 'click', 'tr', function() {
</span><span class="cx" style="display: block; padding: 0 10px"> $( this ).find( '.found-radio input' ).prop( 'checked', true );
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span></span></pre>
</div>
</div>
</body>
</html>