<!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>[BuddyPress][10641] trunk/src/bp-core: Add filters and actions to support short-circuiting of standard avatar/cover image uploads/crops.</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="http://buddypress.trac.wordpress.org/changeset/10641">10641</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/10641","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>djpaul</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-03-09 11:40:10 +0000 (Wed, 09 Mar 2016)</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'>Add filters and actions to support short-circuiting of standard avatar/cover image uploads/crops.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6948">#6948</a>
Props DJPaul, imath</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreattachmentsphp">trunk/src/bp-core/bp-core-attachments.php</a></li>
<li><a href="#trunksrcbpcorebpcoreavatarsphp">trunk/src/bp-core/bp-core-avatars.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoreattachmentsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-attachments.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-attachments.php 2016-03-07 21:28:40 UTC (rev 10640)
+++ trunk/src/bp-core/bp-core-attachments.php 2016-03-09 11:40:10 UTC (rev 10641)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -410,6 +410,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'file' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> ), 'attachments_get_attachment_src' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether or not to handle fetching a BuddyPress image attachment.
+ *
+ * If you want to override this function, make sure you return false.
+ *
+ * @since 2.5.1
+ *
+ * @param null|string $value If null is returned, proceed with default behaviour. Otherwise, value returned verbatim.
+ * @param array $r {
+ * @type string $object_dir The object dir (eg: members/groups). Defaults to members.
+ * @type int $item_id The object id (eg: a user or a group id). Defaults to current user.
+ * @type string $type The type of the attachment which is also the subdir where files are saved.
+ * Defaults to 'cover-image'
+ * @type string $file The name of the file.
+ * }
+ */
+ $pre_filter = apply_filters( 'bp_attachments_pre_get_attachment', null, $r );
+ if ( $pre_filter !== null ) {
+ return $pre_filter;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Get BuddyPress Attachments Uploads Dir datas.
</span><span class="cx" style="display: block; padding: 0 10px"> $bp_attachments_uploads_dir = bp_attachments_uploads_dir_get();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -478,6 +499,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_attachments_delete_file( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $attachment_path = bp_attachments_get_attachment( 'path', $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether or not to handle deleting an existing BuddyPress attachment.
+ *
+ * If you want to override this function, make sure you return false.
+ *
+ * @since 2.5.1
+ *
+ * @param bool $value Whether or not to delete the BuddyPress attachment.
+ * @param array Array of arguments for the attachment deletion.
+ */
+ if ( ! apply_filters( 'bp_attachments_pre_delete_file', true, $args ) ) {
+ return true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $attachment_path ) ) {
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -1223,6 +1258,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> bp_attachments_json_response( false, $is_html4 );
</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">+ /**
+ * Filters whether or not to handle cover image uploading.
+ *
+ * If you want to override this function, make sure you return an array with the 'result' key set.
+ *
+ * @since 2.5.1
+ *
+ * @param array $value
+ * @param array $bp_params
+ * @param array $needs_reset Stores original value of certain globals we need to revert to later.
+ * @param array $object_data
+ */
+ $pre_filter = apply_filters( 'bp_attachments_pre_cover_image_ajax_upload', array(), $bp_params, $needs_reset, $object_data );
+ if ( isset( $pre_filter['result'] ) ) {
+ bp_attachments_json_response( $pre_filter['result'], $is_html4, $pre_filter );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $cover_image_attachment = new BP_Attachment_Cover_Image();
</span><span class="cx" style="display: block; padding: 0 10px"> $uploaded = $cover_image_attachment->upload( $_FILES );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcbpcorebpcoreavatarsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-avatars.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-avatars.php 2016-03-07 21:28:40 UTC (rev 10640)
+++ trunk/src/bp-core/bp-core-avatars.php 2016-03-09 11:40:10 UTC (rev 10641)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -703,6 +703,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args = wp_parse_args( $args, $defaults );
</span><span class="cx" style="display: block; padding: 0 10px"> extract( $args, EXTR_SKIP );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether or not to handle deleting an existing avatar.
+ *
+ * If you want to override this function, make sure you return false.
+ *
+ * @since 2.5.1
+ *
+ * @param bool $value Whether or not to delete the avatar.
+ * @param array $args {
+ * Array of function parameters.
+ *
+ * @type bool|int $item_id ID of the item whose avatar you're deleting.
+ * Defaults to the current item of type $object.
+ * @type string $object Object type of the item whose avatar you're
+ * deleting. 'user', 'group', 'blog', or custom.
+ * Default: 'user'.
+ * @type bool|string $avatar_dir Subdirectory where avatar is located.
+ * Default: false, which falls back on the default location
+ * corresponding to the $object.
+ * }
+ */
+ if ( ! apply_filters( 'bp_core_pre_delete_existing_avatar', true, $args ) ) {
+ return true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $item_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'user' == $object )
</span><span class="cx" style="display: block; padding: 0 10px"> $item_id = bp_displayed_user_id();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1069,6 +1094,21 @@
</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">+ /**
+ * Filters whether or not to handle avatar webcam capture.
+ *
+ * If you want to override this function, make sure you return false.
+ *
+ * @since 2.5.1
+ *
+ * @param bool $value Whether or not to crop.
+ * @param string $data Base64 encoded image.
+ * @param int $item_id Item to associate.
+ */
+ if ( ! apply_filters( 'bp_avatar_pre_handle_capture', true, $data, $item_id ) ) {
+ return true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $avatar_dir = bp_core_avatar_upload_path() . '/avatars';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // It's not a regular upload, we may need to create this folder.
</span></span></pre>
</div>
</div>
</body>
</html>