Changeset 12906

Timestamp:

04/27/2021 04:11:45 AM (5 years ago)

Author:

imath

Message:

Replace the bp_core_avatar_default filter with 2 new filters

The bp_core_avatar_default filter was used for two different purposes:

1. to edit the default BuddyPress avatar [7769].
2. to edit the default Gravatar [10688].

To avoid confusion or generate misleading behaviors, we are deprecating this filter in favor of 2 new filters :

1. Use bp_core_default_avatar to edit the default BuddyPress avatar.
2. Use bp_core_avatar_gravatar_default to edit the default Gravatar.

Props r-a-y

Fixes #8437

Location:

trunk/src

Files:

• bp-blogs/bp-blogs-filters.php (modified) (1 diff)
• bp-core/bp-core-avatars.php (modified) (4 diffs)
• bp-groups/bp-groups-filters.php (modified) (1 diff)

trunk/src/bp-blogs/bp-blogs-filters.php

@@ -159 +159 @@
         return $avatar;
 }
-add_filter( 'bp_core_avatar_default',       'bp_blogs_default_avatar', 10, 2 );
+add_filter( 'bp_core_default_avatar',       'bp_blogs_default_avatar', 10, 2 );
 add_filter( 'bp_core_avatar_default_thumb', 'bp_blogs_default_avatar', 10, 2 );
 

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

@@ -95 +95 @@
 }
 add_action( 'bp_setup_globals', 'bp_core_set_avatar_globals' );
+
+/**
+ * Checks whether a given gravatar is one of the default ones.
+ *
+ * @since 8.0.0
+ *
+ * @param string $d The name of the default gravatar.
+ * @return bool True if it's a default gravatar. False otherwise.
+ */
+function bp_core_is_default_gravatar( $d = '' ) {
+        if ( ! $d ) {
+                return false;
+        }
+
+        /** this filter is documented in wp-admin/options-discussion.php */
+        $gravatar_defaults = apply_filters(
+                'avatar_defaults',
+                array_fill_keys(
+                        array(
+                                'mystery',
+                                'blank',
+                                'gravatar_default',
+                                'identicon',
+                                'wavatar',
+                                'monsterid',
+                                'retro',
+                        ),
+                        ''
+                )
+        );
+
+        return isset( $gravatar_defaults[ $d ] );
+}
 
 /**
@@ -645 +678 @@
                 }
 
+                /** This filter is documented in wp-includes/deprecated.php */
+                $d = apply_filters_deprecated(
+                        'bp_core_avatar_default',
+                        array( $default_grav, $params ),
+                        '8.0.0',
+                        'bp_core_avatar_gravatar_default||bp_core_default_avatar',
+                        __( 'This filter was used for 2 different purposes. If your goal was to filter the default *Gravatar*, please use `bp_core_avatar_gravatar_default` instead. Otherwise, please use `bp_core_default_avatar` instead.', 'buddypress' )
+                );
+
+                if ( bp_core_is_default_gravatar( $d ) ) {
+                        $default_grav = $d;
+                }
+
                 /**
                  * Filters the Gravatar "d" parameter.
                  *
                  * @since 2.6.0
+                 * @since 8.0.0 The name of the filter was changed to `bp_core_avatar_gravatar_default`.
                  *
                  * @param string $default_grav The avatar default.
                  * @param array  $params       The avatar's data.
                  */
-                $default_grav = apply_filters( 'bp_core_avatar_default', $default_grav, $params );
+                $default_grav = apply_filters( 'bp_core_avatar_gravatar_default', $default_grav, $params );
 
                 // Only set default image if 'Gravatar Logo' is not requested.
@@ -1842 +1889 @@
         }
 
+        /** This filter is documented in wp-includes/deprecated.php */
+        $a = apply_filters_deprecated(
+                'bp_core_avatar_default',
+                array( $avatar, $params ),
+                '8.0.0',
+                'bp_core_avatar_gravatar_default||bp_core_default_avatar',
+                __( 'This filter was used for 2 different purposes. If your goal was to filter the default *Gravatar*, please use `bp_core_avatar_gravatar_default` instead. Otherwise, please use `bp_core_default_avatar` instead.', 'buddypress' )
+        );
+
+        if ( ! bp_core_is_default_gravatar( $a ) && false !== strpos( $avatar, '//' ) ) {
+                $avatar = $a;
+        }
+
         /**
          * Filters the URL of the 'full' default avatar.
@@ -1847 +1907 @@
          * @since 1.5.0
          * @since 2.6.0 Added `$params`.
+         * @since 8.0.0 The name of the filter was changed to `bp_core_default_avatar`.
          *
          * @param string $avatar URL of the default avatar.
          * @param array  $params Params provided to bp_core_fetch_avatar().
          */
-        return apply_filters( 'bp_core_avatar_default', $avatar, $params );
+        return apply_filters( 'bp_core_default_avatar', $avatar, $params );
 }
 

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

@@ -70 +70 @@
 
 // Default group avatar.
-add_filter( 'bp_core_avatar_default',       'bp_groups_default_avatar', 10, 3 );
+add_filter( 'bp_core_default_avatar',       'bp_groups_default_avatar', 10, 3 );
 add_filter( 'bp_core_avatar_default_thumb', 'bp_groups_default_avatar', 10, 3 );