Changeset 11314

Timestamp:

12/20/2016 03:11:18 AM (10 years ago)

Author:

boonebgorges

Message:

Improve actions fired after avatar upload.

• Introduce the groups_avatar_uploaded action, which paralells the xprofile_avatar_uploaded filter, and runs after either an AJAX or a non-AJAX group avatar upload.
• Update instances of the xprofile_avatar_uploaded action so that they receive the array of arguments passed to the upload/crop handler.
• Improve documentation for existing actions.

Props bhargavbhandari90.
Fixes #7371.

Location:

trunk/src

Files:

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

trunk/src/bp-core/bp-core-avatars.php

@@ -1294 +1294 @@
                          *              about the way the avatar was set (eg: 'crop' or 'camera')
                          *              Move the action at the right place, once the avatar is set
+                         * @since 2.8.0 Added the `$avatar_data` parameter.
                          *
-                         * @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')
+                         * @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').
+                         * @param array  $avatar_data Array of parameters passed to the avatar handler.
                          */
                         do_action( 'xprofile_avatar_uploaded', (int) $avatar_data['item_id'], $avatar_data['type'] );
@@ -1343 +1345 @@
 
                 if ( 'user' === $avatar_data['object'] ) {
-                        /**
-                         * 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'] );
+                        /** This action is documented in bp-core/bp-core-avatars.php */
+                        do_action( 'xprofile_avatar_uploaded', (int) $avatar_data['item_id'], $avatar_data['type'], $r );
+                } elseif ( 'group' === $avatar_data['object'] ) {
+                        /** This action is documented in bp-groups/bp-groups-screens.php */
+                        do_action( 'groups_avatar_uploaded', (int) $avatar_data['item_id'], $atavar_data['type'], $r );
                 }
 

trunk/src/bp-groups/bp-groups-screens.php

@@ -1066 +1066 @@
                         bp_core_add_message( __( 'There was a problem cropping the group profile photo.', 'buddypress' ), 'error' );
                 } else {
+                        /**
+                         * Fires after a group avatar is uploaded.
+                         *
+                         * @since 2.8.0
+                         *
+                         * @param int    $group_id ID of the group.
+                         * @param string $type     Avatar type. 'crop' or 'full'.
+                         * @param array  $args     Array of parameters passed to the avatar handler.
+                         */
+                        do_action( 'groups_avatar_uploaded', bp_get_current_group_id(), 'crop', $args );
                         bp_core_add_message( __( 'The new group profile photo was uploaded successfully.', 'buddypress' ) );
                 }