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

Timestamp:

04/27/2016 03:59:26 PM (9 years ago)

Author:

boonebgorges

Message:

Introduce 'mystery group' avatar for groups without custom avatar.

This nifty new image is totally grouperiffic, and it's gonna supercharge
your BuddyPress community, to the extreme.

As part of the improvement, Gravatar requests for group avatars have been
disabled by default. Gravatar requests never match for groups, anyway, so
this should save HTTP requests in most cases. Filter 'bp_core_fetch_avatar_no_grav'
to restore the previous behavior.

Props sooskriszta, abweb.
Fixes #6372.

File:

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

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

@@ -176 +176 @@
  *                                   case 'no_grav' should be set to true. To disable Gravatar
  *                                   fallbacks globally, see the 'bp_core_fetch_avatar_no_grav' filter.
- *                                   Default: false.
+ *                                   Default: true for groups, otherwise false.
  *     @type bool       $html        Whether to return an <img> HTML element, vs a raw URL
  *                                   to an avatar. If false, <img>-specific arguments (like 'css_id')
@@ -212 +212 @@
         'alt'           => '',
         'email'         => false,
-        'no_grav'       => false,
+        'no_grav'       => null,
         'html'          => true,
         'title'         => '',
@@ -565 +565 @@
     }
 
+    // By default, Gravatar is not pinged for groups.
+    if ( null === $params['no_grav'] ) {
+        $params['no_grav'] = 'group' === $params['object'];
+    }
+
     /**
      * Filters whether or not to skip Gravatar check.
@@ -672 +677 @@
          * @param array  $params Array of parameters for the avatar request.
          */
-        $gravatar = apply_filters( 'bp_core_default_avatar_' . $params['object'], bp_core_avatar_default( 'local' ), $params );
+        $gravatar = apply_filters( 'bp_core_default_avatar_' . $params['object'], bp_core_avatar_default( 'local', $params ), $params );
     }
 
@@ -1846 +1851 @@
  *
  * @since 1.5.0
- *
- * @param string $type 'local' if the fallback should be the locally-hosted version
- *                     of the mystery-person, 'gravatar' if the fallback should be
- *                     Gravatar's version. Default: 'gravatar'.
+ * @since 2.6.0 Introduced `$params` and `$object_type` parameters.
+ *
+ * @param string $type   'local' if the fallback should be the locally-hosted version
+ *                       of the mystery person, 'gravatar' if the fallback should be
+ *                       Gravatar's version. Default: 'gravatar'.
+ * @param array  $params Parameters passed to bp_core_fetch_avatar().
  * @return string The URL of the default avatar.
  */
-function bp_core_avatar_default( $type = 'gravatar' ) {
+function bp_core_avatar_default( $type = 'gravatar', $params = array() ) {
     // Local override.
     if ( defined( 'BP_AVATAR_DEFAULT' ) ) {
@@ -1870 +1877 @@
      *
      * @since 1.5.0
+     * @since 2.6.0 Added `$params`.
      *
      * @param string $avatar URL of the default avatar.
-     */
-    return apply_filters( 'bp_core_avatar_default', $avatar );
+     * @param array  $params Params provided to bp_core_fetch_avatar().
+     */
+    return apply_filters( 'bp_core_avatar_default', $avatar, $params );
 }
 
@@ -1883 +1892 @@
  *
  * @since 1.5.0
- *
- * @param string $type 'local' if the fallback should be the locally-hosted version
- *                     of the mystery-person, 'gravatar' if the fallback should be
- *                     Gravatar's version. Default: 'gravatar'.
+ * @since 2.6.0 Introduced `$object_type` parameter.
+ *
+ * @param string $type   'local' if the fallback should be the locally-hosted version
+ *                       of the mystery person, 'gravatar' if the fallback should be
+ *                       Gravatar's version. Default: 'gravatar'.
+ * @param array  $params Parameters passed to bp_core_fetch_avatar().
  * @return string The URL of the default avatar thumb.
  */
-function bp_core_avatar_default_thumb( $type = 'gravatar' ) {
+function bp_core_avatar_default_thumb( $type = 'gravatar', $params = array() ) {
     // Local override.
     if ( defined( 'BP_AVATAR_DEFAULT_THUMB' ) ) {
@@ -1907 +1918 @@
      *
      * @since 1.5.0
+     * @since 2.6.0 Added `$params`.
      *
      * @param string $avatar URL of the default avatar.
-     */
-    return apply_filters( 'bp_core_avatar_thumb', $avatar );
+     * @param string $params Params provided to bp_core_fetch_avatar().
+     */
+    return apply_filters( 'bp_core_avatar_thumb', $avatar, $params );
 }