<!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][10135] trunk/src: Make sure the `xprofile_avatar_uploaded` action is fired once the avatar of the user is set.</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/10135">10135</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/10135","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-24 10:36:16 +0000 (Thu, 24 Sep 2015)</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'>Make sure the `xprofile_avatar_uploaded` action is fired once the avatar of the user is set.
In 2.3.0, we introduced a new UI to manage avatar. It now uses Ajax to upload and set the avatar. Unfortunately a confusion was made about the `xprofile_avatar_uploaded` action. It was firing immediately after the avatar was uploaded but before it has been set using the cropping tool.
This commit is:
- making sure the action is fired at the right time
- adding new parameters to the action to inform about the User ID and the way the avatar was set ("crop" or "camera")
- making sure an activity will be generated if the avatar was set within the wp-admin/extended-profile.
Props r-a-y, landwire
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6612">#6612</a> (trunk)</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreavatarsphp">trunk/src/bp-core/bp-core-avatars.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofileactivityphp">trunk/src/bp-xprofile/bp-xprofile-activity.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofilescreensphp">trunk/src/bp-xprofile/bp-xprofile-screens.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2015-09-24 10:28:21 UTC (rev 10134)
+++ trunk/src/bp-core/bp-core-avatars.php 2015-09-24 10:36:16 UTC (rev 10135)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -991,10 +991,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $name_parts = pathinfo( $name );
</span><span class="cx" style="display: block; padding: 0 10px"> $name = trim( substr( $name, 0, - ( 1 + strlen( $name_parts['extension'] ) ) ) );
</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 ( 'user' === $bp_params['object'] ) {
- do_action( 'xprofile_avatar_uploaded' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Finally return the avatar to the editor
</span><span class="cx" style="display: block; padding: 0 10px"> bp_attachments_json_response( true, $is_html4, array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => $name,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1057,13 +1053,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Crop to default values
</span><span class="cx" style="display: block; padding: 0 10px"> $crop_args = array( 'item_id' => $item_id, 'original_file' => $avatar_to_crop, 'crop_x' => 0, 'crop_y' => 0 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Fires if the new avatar was successfully captured.
- *
- * @since 2.3.0
- */
- do_action( 'xprofile_avatar_uploaded' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> return bp_core_avatar_handle_crop( $crop_args );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1200,7 +1189,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'item_id' => $avatar_data['item_id'],
</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">- do_action( 'xprofile_screen_change_avatar' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires if the new avatar was successfully captured.
+ *
+ * @since 1.1.0 Used to inform the avatar was successfully cropped
+ * @since 2.3.4 Add two new parameters to inform about the user id and
+ * about the way the avatar was set (eg: 'crop' or 'camera')
+ * Move the action at the right place, once the avatar is set
+ *
+ * @param string $item_id Inform about the user id the avatar was set for
+ * @param string $type Inform about the way the avatar was set ('camera')
+ */
+ do_action( 'xprofile_avatar_uploaded', (int) $avatar_data['item_id'], $avatar_data['type'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_send_json_success( $return );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1245,7 +1245,18 @@
</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"> if ( 'user' === $avatar_data['object'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'xprofile_screen_change_avatar' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires if the new avatar was successfully cropped.
+ *
+ * @since 1.1.0 Used to inform the avatar was successfully cropped
+ * @since 2.3.4 Add two new parameters to inform about the user id and
+ * about the way the avatar was set (eg: 'crop' or 'camera')
+ * Move the action at the right place, once the avatar is set
+ *
+ * @param string $item_id Inform about the user id the avatar was set for
+ * @param string $type Inform about the way the avatar was set ('crop')
+ */
+ do_action( 'xprofile_avatar_uploaded', (int) $avatar_data['item_id'], $avatar_data['type'] );
</ins><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"> wp_send_json_success( $return );
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofileactivityphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/bp-xprofile-activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-activity.php 2015-09-24 10:28:21 UTC (rev 10134)
+++ trunk/src/bp-xprofile/bp-xprofile-activity.php 2015-09-24 10:36:16 UTC (rev 10135)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -202,27 +202,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds an activity stream item when a user has uploaded a new avatar.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.0.0)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 1.0.0
+ * @since 2.3.4 Add new parameter to get the user id the avatar was set for
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @package BuddyPress XProfile
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_activity_add() Adds an entry to the activity component tables for a
</span><span class="cx" style="display: block; padding: 0 10px"> * specific activity
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @param int $user_id The user id the avatar was set for
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function bp_xprofile_new_avatar_activity() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_xprofile_new_avatar_activity( $user_id = 0 ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bail if activity component is not active
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! bp_is_active( 'activity' ) ) {
</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">+ if ( empty( $user_id ) ) {
+ $user_id = bp_displayed_user_id();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the user ID when a user has uploaded a new avatar.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.5.0)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 1.5.0
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $value ID of the displayed user.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $user_id ID of the user the avatar was set for.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_id = apply_filters( 'bp_xprofile_new_avatar_user_id', bp_displayed_user_id() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_id = apply_filters( 'bp_xprofile_new_avatar_user_id', $user_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add the activity
</span><span class="cx" style="display: block; padding: 0 10px"> bp_activity_add( array(
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofilescreensphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/bp-xprofile-screens.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-screens.php 2015-09-24 10:28:21 UTC (rev 10134)
+++ trunk/src/bp-xprofile/bp-xprofile-screens.php 2015-09-24 10:36:16 UTC (rev 10135)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -266,9 +266,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires right before the redirect, after processing a new avatar.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.1.0)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 1.1.0
+ * @since 2.3.4 Add two new parameters to inform about the user id and
+ * about the way the avatar was set (eg: 'crop' or 'camera')
+ *
+ * @param string $item_id Inform about the user id the avatar was set for
+ * @param string $value Inform about the way the avatar was set ('crop')
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'xprofile_avatar_uploaded' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action( 'xprofile_avatar_uploaded', (int) $args['item_id'], 'crop' );
</ins><span class="cx" style="display: block; padding: 0 10px"> bp_core_add_message( __( 'Your new profile photo was uploaded successfully.', 'buddypress' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> bp_core_redirect( bp_displayed_user_domain() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>