<!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" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { 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 #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#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>
<title>[16383] trunk/wp-admin/includes/media.php: Make media_handle_sideload()
return attachment id instead of URL.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/16383">16383</a></dd>
<dt>Author</dt> <dd>scribu</dd>
<dt>Date</dt> <dd>2010-11-15 12:53:11 +0000 (Mon, 15 Nov 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>Make media_handle_sideload() return attachment id instead of URL. Props joostdevalk. Fixes <a href="http://trac.wordpress.org/ticket/15432">#15432</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludesmediaphp">trunk/wp-admin/includes/media.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludesmediaphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/media.php (16382 => 16383)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/media.php 2010-11-15 11:24:55 UTC (rev 16382)
+++ trunk/wp-admin/includes/media.php 2010-11-15 12:53:11 UTC (rev 16383)
</span><span class="lines">@@ -239,15 +239,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * {@internal Missing Short Description}}
</del><ins>+ * This handles a sideloaded file in the same way as an uploaded file is handled by {@link media_handle_upload()}
</ins><span class="cx"> *
</span><del>- * @since unknown
</del><ins>+ * @since 2.6
</ins><span class="cx"> *
</span><del>- * @param unknown_type $file_array
- * @param unknown_type $post_id
- * @param unknown_type $desc
- * @param unknown_type $post_data
- * @return unknown
</del><ins>+ * @param array $file_array Array similar to a {@link $_FILES} upload array
+ * @param int $post_id The post ID the media is associated with
+ * @param string $desc Description of the sideloaded file
+ * @param array $post_data allows you to overwrite some of the attachment
+ * @return int|object The ID of the attachment or a WP_Error on failure
</ins><span class="cx"> */
</span><span class="cx"> function media_handle_sideload($file_array, $post_id, $desc = null, $post_data = array()) {
</span><span class="cx"> $overrides = array('test_form'=>false);
</span><span class="lines">@@ -283,10 +283,9 @@
</span><span class="cx">
</span><span class="cx"> // Save the attachment metadata
</span><span class="cx"> $id = wp_insert_attachment($attachment, $file, $post_id);
</span><del>- if ( !is_wp_error($id) ) {
</del><ins>+ if ( !is_wp_error($id) )
</ins><span class="cx"> wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $file ) );
</span><del>- return $url;
- }
</del><ins>+
</ins><span class="cx"> return $id;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -518,14 +517,14 @@
</span><span class="cx"> $file_array['tmp_name'] = $tmp;
</span><span class="cx">
</span><span class="cx"> // If error storing temporarily, unlink
</span><del>- if ( is_wp_error($tmp) ) {
</del><ins>+ if ( is_wp_error( $tmp ) ) {
</ins><span class="cx"> @unlink($file_array['tmp_name']);
</span><span class="cx"> $file_array['tmp_name'] = '';
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // do the validation and storage stuff
</span><del>- $id = media_handle_sideload($file_array, $post_id, @$desc);
- $src = $id;
</del><ins>+ $id = media_handle_sideload( $file_array, $post_id, @$desc );
+ $src = get_attachment_link( $id );
</ins><span class="cx">
</span><span class="cx"> // If error storing permanently, unlink
</span><span class="cx"> if ( is_wp_error($id) ) {
</span></span></pre>
</div>
</div>
</body>
</html>