Changeset 12772

Timestamp:

10/30/2020 10:13:38 PM (4 years ago)

Author:

imath

Message:

Blogs: use a default "blavatar" when the blog has no site icon

So far when the Blogs component was not supporting the WordPress site icon feature or when the blog had no site icon set, we used to fallback on the Blog Administrator's avatar.

We realized this was a wrong approach, because:

• the site creator may no longer be a member of the specific site, in which case the lowest id will belong to a different (non-admin) user.
• The site admin may have changed in some other way.
• The site creator's account may have been deleted.
• Etc.

When any of these happen, you get the avatar of a random site user.

That's why just like we do for users or groups, we are now using a default blog avatar (mysterious-blog.png) as a fallback when the site icon for the blog is not available.

Props boonebgorges, vapvarun, johnjamesjacoby

Fixes #8179

Location:

trunk

Files:

• src/bp-blogs/bp-blogs-filters.php (modified) (1 diff)
• src/bp-blogs/bp-blogs-template.php (modified) (4 diffs)
• src/bp-core/images/mystery-blog-50.png (added)
• src/bp-core/images/mystery-blog.png (added)
• tests/phpunit/testcases/blogs/template.php (modified) (2 diffs)

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

@@ -138 +138 @@
 
 /**
+ * Use the mystery blog avatar for blogs.
+ *
+ * @since 7.0.0
+ *
+ * @param string $avatar Current avatar src.
+ * @param array  $params Avatar params.
+ * @return string
+ */
+function bp_blogs_default_avatar( $avatar, $params ) {
+    if ( isset( $params['object'] ) && 'blog' === $params['object'] ) {
+        if ( isset( $params['type'] ) && 'thumb' === $params['type'] ) {
+            $file = 'mystery-blog-50.png';
+        } else {
+            $file = 'mystery-blog.png';
+        }
+
+        $avatar = buddypress()->plugin_url . "bp-core/images/$file";
+    }
+
+    return $avatar;
+}
+add_filter( 'bp_core_avatar_default',       'bp_blogs_default_avatar', 10, 2 );
+add_filter( 'bp_core_avatar_default_thumb', 'bp_blogs_default_avatar', 10, 2 );
+
+/**
  * Filters the column name during blog metadata queries.
  *

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

@@ -299 +299 @@
      * Get a blog's avatar.
      *
-     * At the moment, blog avatars are simply the user avatars of the blog
-     * admin. Filter 'bp_get_blog_avatar_' . $blog_id to customize.
+     * At the moment, unless the blog has a site icon, the blog's avatar defaults
+     * to the /bp-core/images/mystery-blog.png image or the Blog's Admin user avatar
+     * if the `admin_user_id` argument contains the Blog's Admin user ID.
      *
      * @since 2.4.0 Introduced `$title` argument.
      * @since 6.0.0 Introduced the `$blog_id`, `$admin_user_id` and `html` arguments.
+     * @since 7.0.0 Introduced the Blog's default avatar {@see bp_blogs_default_avatar()}.
+     *              Removed the `'bp_get_blog_avatar_' . $blog_id` filter (it was deprecated since 1.5).
      *
      * @see bp_core_fetch_avatar() For a description of arguments and
@@ -334 +337 @@
         }
 
-        // Set default values.
-        $author_displayname = '';
-        $admin_user_id      = 0;
-        $blog_id            = 0;
-
-        if ( ! $blogs_template && isset( $args['admin_user_id'] ) && $args['admin_user_id'] ) {
-            $admin_user_id      = (int) $args['admin_user_id'];
-            $author_displayname = bp_core_get_user_displayname( $admin_user_id );
-        } else {
-            $admin_user_id      = $blogs_template->blog->admin_user_id;
-            $author_displayname = bp_core_get_user_displayname( $blogs_template->blog->admin_user_id );
-        }
+        // Set default value for the `alt` attribute.
+        $alt_attribute = __( 'Site icon for the blog', 'buddypress' );
 
         if ( ! $blogs_template && isset( $args['blog_id'] ) && $args['blog_id'] ) {
             $blog_id = (int) $args['blog_id'];
         } else {
-            $blog_id = bp_get_blog_id();
+            $blog_id       = bp_get_blog_id();
+            $alt_attribute = sprintf( __( 'Site icon for %s', 'buddypress' ), bp_get_blog_name() );
         }
 
         // Parse the arguments.
         $r = bp_parse_args( $args, array(
-            'type'    => 'full',
-            'width'   => false,
-            'height'  => false,
-            'class'   => 'avatar',
-            'id'      => false,
-            'alt'     => sprintf(
-                /* translators: %s: the author display name */
-                __( 'Profile picture of site author %s', 'buddypress' ),
-                esc_attr( $author_displayname )
-            ),
-            'no_grav' => false,
-            'html'    => true,
-        ) );
+            'item_id'    => $blog_id,
+            'avatar_dir' => 'blog-avatars',
+            'object'     => 'blog',
+            'type'       => 'full',
+            'width'      => false,
+            'height'     => false,
+            'class'      => 'avatar',
+            'id'         => false,
+            'alt'        => $alt_attribute,
+            'no_grav'    => false,
+            'html'       => true,
+        ), 'blog_avatar' );
+
+        /**
+         * If the `admin_user_id` was provided, make the Blog avatar
+         * defaults to the Blog's Admin user one.
+         */
+        if ( isset( $r['admin_user_id'] ) && $r['admin_user_id'] ) {
+            $r['item_id']    = (int) $r['admin_user_id'];
+            $r['avatar_dir'] = 'avatars';
+            $r['object']     = 'user';
+        } elseif ( ! $r['no_grav'] ) {
+            $r['no_grav'] = true;
+        }
 
         // Use site icon if available.
@@ -421 +426 @@
                 }
 
-                $alt_attribute = __( 'Site icon for the blog', 'buddypress' );
-                if ( $blogs_template ) {
-                    /* translators: %s is the placeholder for the name of the blog */
-                    $alt_attribute = sprintf( __( 'Site icon for %s', 'buddypress' ), bp_get_blog_name() );
-                }
-
                 $avatar = sprintf( '<img src="%1$s" class="%2$s" width="%3$s" height="%3$s" alt="%4$s" />',
                     esc_url( $site_icon ),
@@ -436 +435 @@
         }
 
-        // Fallback to user ID avatar.
+        // Fallback to Default blog avatar.
         if ( '' === $avatar ) {
-            $avatar = bp_core_fetch_avatar( array(
-                'item_id' => $admin_user_id,
-                // 'avatar_dir' => 'blog-avatars',
-                // 'object'     => 'blog',
-                'type'    => $r['type'],
-                'alt'     => $r['alt'],
-                'css_id'  => $r['id'],
-                'class'   => $r['class'],
-                'width'   => $r['width'],
-                'height'  => $r['height'],
-                'no_grav' => $r['no_grav'],
-                'html'    => $r['html'],
-            ) );
-        }
-
-        /**
-         * In future BuddyPress versions you will be able to set the avatar for a blog.
-         * Right now you can use a filter with the ID of the blog to change it if you wish.
-         * By default it will return the avatar for the primary blog admin.
-         *
-         * This filter is deprecated as of BuddyPress 1.5 and may be removed in a future version.
-         * Use the 'bp_get_blog_avatar' filter instead.
-         */
-        $avatar = apply_filters( 'bp_get_blog_avatar_' . $blog_id, $avatar );
+            $avatar = bp_core_fetch_avatar( $r );
+        }
 
         /**

trunk/tests/phpunit/testcases/blogs/template.php

@@ -398 +398 @@
 
         $blogs_template = $reset_blogs_template;
-
-        $this->assertTrue( $avatar === bp_core_fetch_avatar( array(
-            'type'          => 'full',
-            'item_id'       => $u,
-            'alt'           => 'test',
-            'no_grav'       => true,
-            'class'         => 'avatar',
-        ) ) );
+        $expected       = bp_core_fetch_avatar(
+            array(
+                'type'    => 'full',
+                'item_id' => $u,
+                'alt'     => 'test',
+                'no_grav' => true,
+                'class'   => 'avatar',
+            )
+        );
+
+        $this->assertTrue( $avatar === $expected );
     }
 
@@ -445 +448 @@
     }
 
+    /**
+     * @group avatar
+     * @group BP_Blogs_Template
+     * @group bp_get_blog_avatar
+     */
+    public function test_bp_get_blog_default_avatar() {
+        if ( ! is_multisite() ) {
+            $this->markTestSkipped();
+        }
+
+        global $blogs_template;
+        $reset_blogs_template = $blogs_template;
+        $blogs_template = null;
+
+        $u = self::factory()->user->create();
+        $b = self::factory()->blog->create( array(
+            'title' => 'The Foo Bar Blog',
+            'user_id' => $u,
+        ) );
+
+        $avatar = bp_get_blog_avatar(
+            array(
+                'type'    => 'thumb',
+                'blog_id' => $b,
+                'html'    => false,
+            )
+        );
+
+        $blogs_template = $reset_blogs_template;
+        $expected       = buddypress()->plugin_url . "bp-core/images/mystery-blog-50.png";
+
+        $this->assertTrue( $avatar === $expected );
+    }
+
     public function filter_blog_avatar() {
         return BP_TESTS_DIR . 'assets/upside-down.jpg';