Changeset 9960

Timestamp:

06/22/2015 02:14:25 PM (9 years ago)

Author:

boonebgorges

Message:

Introduce 'title' argument for bp_get_blog_avatar().

This changeset also changes the default value of the 'title' attribute of blog
avatars to the display name of the site admin. The previous value was the site
admin's email address, which could introduce privacy concerns.

Props lenasterg.
Fixes #6519.

Location:

trunk

Files:

• src/bp-blogs/bp-blogs-template.php (modified) (5 diffs)
• tests/phpunit/testcases/blogs/template.php (modified) (1 diff)

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

@@ -524 +524 @@
      * admin. Filter 'bp_get_blog_avatar_' . $blog_id to customize.
      *
+     * @since BuddyPress (2.4.0) Introduced `$title` argument.
+     *
      * @see bp_core_fetch_avatar() For a description of arguments and
      *      return values.
@@ -533 +535 @@
      *     @type string   $alt     Default: 'Profile picture of site author [user name]'.
      *     @type string   $class   Default: 'avatar'.
+     *     @type string   $title   Default: 'Profile picture of site author [user name]'.
      *     @type string   $type    Default: 'full'.
      *     @type int|bool $width   Default: false.
@@ -550 +553 @@
         }
 
+        $author_displayname = bp_core_get_user_displayname( $blogs_template->blog->admin_user_id );
+
         // Parse the arguments
         $r = bp_parse_args( $args, array(
@@ -556 +561 @@
             'height'  => false,
             'class'   => 'avatar',
+            'title'   => sprintf( __( 'Profile picture of site author %s', 'buddypress' ), esc_attr( $author_displayname ) ),
             'id'      => false,
-            'alt'     => sprintf( __( 'Profile picture of site author %s', 'buddypress' ), bp_core_get_user_displayname( $blogs_template->blog->admin_user_id ) ),
+            'alt'     => sprintf( __( 'Profile picture of site author %s', 'buddypress' ), esc_attr( $author_displayname ) ),
             'no_grav' => true,
         ) );
@@ -564 +570 @@
         $avatar = bp_core_fetch_avatar( array(
             'item_id'    => $blogs_template->blog->admin_user_id,
-            'title'      => $blogs_template->blog->admin_user_email,
+            'title'      => $r['title'],
             //'avatar_dir' => 'blog-avatars',
             //'object'     => 'blog',

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

@@ -367 +367 @@
         $_REQUEST = $request;
     }
+
+    /**
+     * @ticket BP6519
+     */
+    public function test_bp_blog_get_avatar_should_respect_title_parameter() {
+        global $blogs_template;
+
+        if ( isset( $blogs_template ) ) {
+            $_blogs_template = $blogs_template;
+        }
+
+        $user = $this->factory->user->create_and_get();
+
+        $blogs_template = new stdClass;
+        $blogs_template->blog = new stdClass;
+        $blogs_template->blog->blog_id = get_current_blog_id();
+        $blogs_template->blog->admin_user_id = $user->ID;
+        $blogs_template->blog->admin_user_email = $user->user_email;
+
+        $actual = bp_get_blog_avatar( array(
+            'title' => 'Foo',
+        ) );
+
+        if ( isset( $_blogs_template ) ) {
+            $blogs_template = $_blogs_template;
+        } else {
+            unset( $blogs_template );
+        }
+
+        $this->assertContains( 'title="Foo"', $actual );
+    }
+
+    /**
+     * @ticket BP6519
+     */
+    public function test_bp_blog_get_avatar_title_attribute_should_default_to_user_displayname() {
+        global $blogs_template;
+
+        if ( isset( $blogs_template ) ) {
+            $_blogs_template = $blogs_template;
+        }
+
+        $user = $this->factory->user->create_and_get();
+
+        $blogs_template = new stdClass;
+        $blogs_template->blog = new stdClass;
+        $blogs_template->blog->blog_id = get_current_blog_id();
+        $blogs_template->blog->admin_user_id = $user->ID;
+        $blogs_template->blog->admin_user_email = $user->user_email;
+
+        $actual = bp_get_blog_avatar();
+
+        if ( isset( $_blogs_template ) ) {
+            $blogs_template = $_blogs_template;
+        } else {
+            unset( $blogs_template );
+        }
+
+        $this->assertContains( 'title="Profile picture of site author ' . bp_core_get_user_displayname( $user->ID ) . '"', $actual );
+    }
 }