Changeset 13177 for trunk/src/bp-core/bp-core-avatars.php

Timestamp:

12/11/2021 01:40:24 PM (5 years ago)

Author:

imath

Message:

Make sure the new_avatar activity can use the avatar crop results

Since [13175] the BP_Attachment_Avatar::crop() method include the timestamp the avatar was generated on into its returned array. This array is now transported into the action the function creating a new_avatar activity hooks to. This function (bp_members_new_avatar_activity()) now accepts 3 more parameters included the transported crop results. This makes it possible to use the timestamp when the avatar was generated on as the new_avatar activity recorded time. Doing so, we don't need to add an extra activity meta to store the name of the avatar file to be sure to display the avatar the user had at the time the activity was created.

Props vapvarun, oztaser

See #8581

File:

• trunk/src/bp-core/bp-core-avatars.php (modified) (10 diffs)

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

@@ -1177 +1177 @@
  *
  * @since 2.3.0
+ * @since 10.0.0 Adds the `$return` param to eventually return the crop result.
  *
  * @param string $data    Base64 encoded image.
  * @param int    $item_id Item to associate.
- * @return bool True on success, false on failure.
- */
-function bp_avatar_handle_capture( $data = '', $item_id = 0 ) {
+ * @param string $return  Whether to get the crop `array` or a `boolean`. Defaults to `boolean`.
+ * @return array|bool True on success, false on failure.
+ */
+function bp_avatar_handle_capture( $data = '', $item_id = 0, $return = 'boolean' ) {
         if ( empty( $data ) || empty( $item_id ) ) {
                 return false;
@@ -1238 +1240 @@
                 $crop_args = array( 'item_id' => $item_id, 'original_file' => $avatar_to_crop, 'crop_x' => 0, 'crop_y' => 0 );
 
+                if ( 'array' === $return ) {
+                        return bp_core_avatar_handle_crop( $crop_args, 'array' );
+                }
+
                 return bp_core_avatar_handle_crop( $crop_args );
         } else {
@@ -1248 +1254 @@
  *
  * @since 1.1.0
+ * @since 10.0.0 Adds the `$return` param to eventually return the crop result.
  *
  * @param array|string $args {
@@ -1266 +1273 @@
  *     @type int         $crop_y        The vertical starting point of the crop. Default: 0.
  * }
- * @return bool True on success, false on failure.
- */
-function bp_core_avatar_handle_crop( $args = '' ) {
+ * @param string       $return Whether to get the crop `array` or a `boolean`. Defaults to `boolean`.
+ * @return array|bool True or the crop result on success, false on failure.
+ */
+function bp_core_avatar_handle_crop( $args = '', $return = 'boolean' ) {
 
         $r = bp_parse_args(
@@ -1307 +1315 @@
         }
 
+        if ( 'array' === $return ) {
+                return $cropped;
+        }
+
         return true;
 }
@@ -1353 +1365 @@
                 }
 
-                if ( ! bp_avatar_handle_capture( $webcam_avatar, $avatar_data['item_id'] ) ) {
+                $cropped_webcam_avatar = bp_avatar_handle_capture( $webcam_avatar, $avatar_data['item_id'], 'array' );
+
+                if ( ! $cropped_webcam_avatar ) {
                         wp_send_json_error( array(
                                 'feedback_code' => 1
@@ -1360 +1374 @@
                 } else {
                         $return = array(
-                                'avatar' => esc_url( bp_core_fetch_avatar( array(
-                                        'object'  => $avatar_data['object'],
-                                        'item_id' => $avatar_data['item_id'],
-                                        'html'    => false,
-                                        'type'    => 'full',
-                                ) ) ),
+                                'avatar' => esc_url(
+                                        bp_core_fetch_avatar(
+                                                array(
+                                                        'object'  => $avatar_data['object'],
+                                                        'item_id' => $avatar_data['item_id'],
+                                                        'html'    => false,
+                                                        'type'    => 'full',
+                                                )
+                                        )
+                                ),
                                 'feedback_code' => 2,
                                 'item_id'       => $avatar_data['item_id'],
@@ -1377 +1395 @@
                          *
                          * @since 6.0.0
+                         * @since 10.0.0 Adds a new param: an array containing the full, thumb avatar and the timestamp.
                          *
-                         * @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.
+                         * @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 crop handler.
+                         * @param array  $cropped_webcam_avatar Array containing the full, thumb avatar and the timestamp.
                          */
-                        do_action( 'bp_members_avatar_uploaded', (int) $avatar_data['item_id'], $avatar_data['type'], $avatar_data );
+                        do_action( 'bp_members_avatar_uploaded', (int) $avatar_data['item_id'], $avatar_data['type'], $avatar_data, $cropped_webcam_avatar );
 
                         wp_send_json_success( $return );
@@ -1414 +1434 @@
 
         // Handle crop.
-        if ( bp_core_avatar_handle_crop( $r ) ) {
+        $cropped_avatar = bp_core_avatar_handle_crop( $r, 'array' );
+
+        if ( $cropped_avatar ) {
                 $return = array(
-                        'avatar' => esc_url( bp_core_fetch_avatar( array(
-                                'object'  => $avatar_data['object'],
-                                'item_id' => $avatar_data['item_id'],
-                                'html'    => false,
-                                'type'    => 'full',
-                        ) ) ),
+                        'avatar' => esc_url(
+                                bp_core_fetch_avatar(
+                                        array(
+                                                'object'  => $avatar_data['object'],
+                                                'item_id' => $avatar_data['item_id'],
+                                                'html'    => false,
+                                                'type'    => 'full',
+                                        )
+                                )
+                        ),
                         'feedback_code' => 2,
                         'item_id'       => $avatar_data['item_id'],
@@ -1431 +1457 @@
 
                         /** This action is documented in bp-core/bp-core-avatars.php */
-                        do_action( 'bp_members_avatar_uploaded', (int) $avatar_data['item_id'], $avatar_data['type'], $r );
+                        do_action( 'bp_members_avatar_uploaded', (int) $avatar_data['item_id'], $avatar_data['type'], $r, $cropped_avatar );
                 } 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'], $avatar_data['type'], $r );
+                        do_action( 'groups_avatar_uploaded', (int) $avatar_data['item_id'], $avatar_data['type'], $r, $cropped_avatar );
                 }