Changeset 10134

Timestamp:

09/24/2015 10:28:21 AM (9 years ago)

Author:

imath

Message:

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

See #6612 (branch 2.3)

Location:

branches/2.3/src

Files:

• bp-core/bp-core-avatars.php (modified) (4 diffs)
• bp-xprofile/bp-xprofile-activity.php (modified) (2 diffs)
• bp-xprofile/bp-xprofile-screens.php (modified) (1 diff)

branches/2.3/src/bp-core/bp-core-avatars.php

@@ -988 +988 @@
     $name = trim( substr( $name, 0, - ( 1 + strlen( $name_parts['extension'] ) ) ) );
 
-    if ( 'user' === $bp_params['object'] ) {
-        do_action( 'xprofile_avatar_uploaded' );
-    }
-
     // Finally return the avatar to the editor
     bp_attachments_json_response( true, $is_html4, array(
@@ -1042 +1038 @@
         // Crop to default values
         $crop_args = array( 'item_id' => $item_id, 'original_file' => $avatar_to_crop, 'crop_x' => 0, 'crop_y' => 0 );
-
-        do_action( 'xprofile_avatar_uploaded' );
 
         return bp_core_avatar_handle_crop( $crop_args );
@@ -1179 +1173 @@
             );
 
-            do_action( 'xprofile_screen_change_avatar' );
+            /**
+             * 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'] );
 
             wp_send_json_success( $return );
@@ -1224 +1229 @@
 
         if ( 'user' === $avatar_data['object'] ) {
-            do_action( 'xprofile_screen_change_avatar' );
+            /**
+             * 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'] );
         }
 

branches/2.3/src/bp-xprofile/bp-xprofile-activity.php

@@ -203 +203 @@
  * Adds an activity stream item when a user has uploaded a new avatar.
  *
- * @since BuddyPress (1.0.0)
+ * @since 1.0.0
+ * @since 2.3.4 Add new parameter to get the user id the avatar was set for
  *
  * @package BuddyPress XProfile
  * @uses bp_activity_add() Adds an entry to the activity component tables for a
  *                         specific activity
- */
-function bp_xprofile_new_avatar_activity() {
-
-    // Bail if activity component is not active
-    if ( ! bp_is_active( 'activity' ) ) {
-        return false;
+ *
+ * @param  int $user_id The user id the avatar was set for
+ */
+function bp_xprofile_new_avatar_activity( $user_id = 0 ) {
+
+    // Bail if activity component is not active
+    if ( ! bp_is_active( 'activity' ) ) {
+        return false;
+    }
+
+    if ( empty( $user_id ) ) {
+        $user_id = bp_displayed_user_id();
     }
 
@@ -219 +226 @@
      * Filters the user ID when a user has uploaded a new avatar.
      *
-     * @since BuddyPress (1.5.0)
-     *
-     * @param int $value ID of the displayed user.
-     */
-    $user_id = apply_filters( 'bp_xprofile_new_avatar_user_id', bp_displayed_user_id() );
+     * @since 1.5.0
+     *
+     * @param int $user_id ID of the user the avatar was set for.
+     */
+    $user_id = apply_filters( 'bp_xprofile_new_avatar_user_id', $user_id );
 
     // Add the activity

branches/2.3/src/bp-xprofile/bp-xprofile-screens.php

@@ -264 +264 @@
              * Fires right before the redirect, after processing a new avatar.
              *
-             * @since BuddyPress (1.1.0)
+             * @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')
              */
-            do_action( 'xprofile_avatar_uploaded' );
+            do_action( 'xprofile_avatar_uploaded', (int) $args['item_id'], 'crop' );
             bp_core_add_message( __( 'Your new profile photo was uploaded successfully.', 'buddypress' ) );
             bp_core_redirect( bp_displayed_user_domain() );