Changeset 14151

Timestamp:

12/16/2025 05:13:46 PM (3 months ago)

Author:

espellcaste

Message:

Add pre-filter hook for avatar history.

Add bp_pre_avatar_get_avatars_history filter to allow short-circuiting avatar history retrieval.
Fix typo @parma to @param in bp_core_avatar_handle_upload docblock.

Props GaryJ.

See #9311 (14.0)

Location:

branches/14.0/src/bp-core

Files:

• bp-core-attachments.php (modified) (1 diff)
• bp-core-avatars.php (modified) (3 diffs)

branches/14.0/src/bp-core/bp-core-attachments.php

@@ -721 +721 @@
     // Enqueue me just once per page, please.
     if ( did_action( 'bp_attachments_enqueue_scripts' ) ) {
-        return;
+        return null;
     }
 

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

@@ -967 +967 @@
      * Filters whether or not to handle uploading.
      *
-     * If you want to override this function, make sure you return false.
+     * If you want to override this function, make sure you return `false`.
      *
      * @since 1.2.4
      *
-     * @param bool   $value             Whether or not to crop.
+     * @param bool   $pre_filter        Whether or not to crop. Defaults to true.
      * @param array  $file              Appropriate entry from $_FILES superglobal.
-     * @parma string $upload_dir_filter A filter to be applied to 'upload_dir'.
+     * @param string $upload_dir_filter A filter to be applied to 'upload_dir'.
      */
     if ( ! apply_filters( 'bp_core_pre_avatar_handle_upload', true, $file, $upload_dir_filter ) ) {
@@ -2218 +2218 @@
      *
      * @param bool $avatar_history True to disable avatar history. False otherwise.
-     *                    Default: `false`.
+     *                             Default: `false`.
      */
     return apply_filters( 'bp_disable_avatar_history', false );
@@ -2270 +2270 @@
  */
 function bp_avatar_get_avatars_history( $item_id = 0, $object = 'user', $type = 'full' ) {
+    /**
+     * Filter to short-circuit the avatars history retrieval process.
+     *
+     * If you want to override this function, make sure you return something other than `null`.
+     *
+     * @since 14.5.0
+     *
+     * @param null|array $pre_filter Null to proceed with the default handling, or an array of avatars to override it.
+     * @param int        $item_id    The item ID we need the avatar version for.
+     * @param string     $object     The object the item ID relates to.
+     * @param string     $type       Get the `full`, `thumb` or `both` versions.
+     */
+    $pre_filter = apply_filters( 'bp_pre_avatar_get_avatars_history', null, $item_id, $object, $type );
+
+    if ( null !== $pre_filter ) {
+        return $pre_filter;
+    }
+
     if ( ! $item_id ) {
         return array();