Ticket #44033: 44033.3.diff

src/wp-includes/link-template.php

@@ -3927 +3927 @@
         return $args['url'];
 }
 
+
+/**
+ * Is this an allowed comment type for retrieving avatars.
+ *
+ * @since 4.9.7
+ *
+ * @param string $comment_type Comment Type
+ *
+ * @return bool Whether the comment type is allowed for retrieving avatars.
+ */
+function is_avatar_comment_type( $comment_type ) {
+        /**
+         * Filters the list of allowed comment types for retrieving avatars.
+         *
+         * @since 3.0.0
+         *
+         * @param array $types An array of content types. Default only contains 'comment'.
+         */
+        $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
+
+        return in_array( $comment_type, (array) $allowed_comment_types, true );
+}
+
+
 /**
  * Retrieves default data about the avatar.
  *
@@ -4071 +4095 @@
                 // Post Object
                 $user = get_user_by( 'id', (int) $id_or_email->post_author );
         } elseif ( $id_or_email instanceof WP_Comment ) {
-                /**
-                 * Filters the list of allowed comment types for retrieving avatars.
-                 *
-                 * @since 3.0.0
-                 *
-                 * @param array $types An array of content types. Default only contains 'comment'.
-                 */
-                $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
-                if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) ) {
+                if ( ! is_avatar_comment_type( get_comment_type( $id_or_email ) ) ) {
                         $args['url'] = false;
                         /** This filter is documented in wp-includes/link-template.php */
                         return apply_filters( 'get_avatar_data', $args, $id_or_email );

tests/phpunit/tests/avatar.php

@@ -240 +240 @@
                 return $this->fakeURL;
         }
 
+        /**
+         * The `get_avatar_data()` function should return gravatar url when comment type allowed to retrieve avatars.
+         *
+         * @ticket 44033
+         */
+        public function test_get_avatar_data_should_return_gravatar_url_when_input_avatar_comment_type() {
+                $comment_type = 'comment';
+                $comment      = self::factory()->comment->create_and_get(
+                        array(
+                                'comment_author_email' => 'commenter@example.com',
+                                'comment_type'         => $comment_type,
+                        )
+                );
+
+                $actual_data = get_avatar_data( $comment );
+
+                $this->assertTrue( is_avatar_comment_type( $comment_type ) );
+                $this->assertRegexp( '|^http?://[0-9]+.gravatar.com/avatar/[0-9a-f]{32}\?|', $actual_data['url'] );
+        }
+
+        /**
+         * The `get_avatar_data()` function should return invalid url when comment type not allowed to retrieve avatars.
+         *
+         * @ticket 44033
+         */
+        public function test_get_avatar_data_should_return_invalid_url_when_input_not_avatar_comment_type() {
+                $comment_type = 'review';
+                $comment      = self::factory()->comment->create_and_get(
+                        array(
+                                'comment_author_email' => 'commenter@example.com',
+                                'comment_type'         => $comment_type,
+                        )
+                );
+
+                $actual_data = get_avatar_data( $comment );
+
+                $this->assertFalse( is_avatar_comment_type( $comment_type ) );
+                $this->assertFalse( $actual_data['url'] );
+        }
+
 }

new file tests/phpunit/tests/comment/isAvatarCommentType.php

@@ +1 @@
+<?php
+/**
+ * Test cases for the `is_avatar_comment_type()` function.
+ *
+ * @package WordPress\UnitTests
+ *
+ * @since 4.9.7
+ */
+
+/**
+ * Tests_Comment_IsAvatarCommentType class.
+ *
+ * @group comment
+ * @covers is_avatar_comment_type
+ *
+ * @since 4.9.7
+ */
+class Tests_Comment_IsAvatarCommentType extends WP_UnitTestCase {
+        /**
+         * Test the `is_avatar_comment_type()` function.
+         *
+         * @since 4.9.7
+         *
+         * @dataProvider data_is_avatar_comment_type
+         */
+        public function test_function( $comment_type, $expected ) {
+                $this->assertSame( $expected, is_avatar_comment_type( $comment_type ) );
+        }
+
+        /**
+         * Dataprovider for `is_avatar_comment_type()`.
+         *
+         * @since 4.9.7
+         *
+         * @return array {
+         *     @type array {
+         *         @type string Comment type.
+         *         @type bool   Expected values.
+         *     }
+         * }
+         */
+        public function data_is_avatar_comment_type() {
+                return array(
+                        array( null, false ),
+                        array( '', false ),
+                        array( 'non-existing-comment-type', false ),
+                        array( 'comment', true ),
+                );
+        }
+
+        /**
+         * The function should be filterable with the `get_avatar_comment_types` filter.
+         *
+         * @since 4.9.7
+         */
+        public function test_function_should_be_filterable() {
+                $this->assertFalse( is_avatar_comment_type( 'review' ) );
+
+                add_filter( 'get_avatar_comment_types', array( $this, '_filter_avatar_comment_types' ) );
+                $actual_comment = is_avatar_comment_type( 'comment' );
+                $actual_review  = is_avatar_comment_type( 'review' );
+                remove_filter( 'get_avatar_comment_types', array( $this, '_filter_avatar_comment_types' ) );
+
+                $this->assertTrue( $actual_comment );
+                $this->assertTrue( $actual_review );
+        }
+
+        /**
+         * Filters callback that modifies the list of allowed comment types for retrieving avatars.
+         *
+         * @since 4.9.7
+         *
+         * @param  array $types An array of content types.
+         * @return array $types An array of content types.
+         */
+        public function _filter_avatar_comment_types( $types ) {
+                $types[] = 'review';
+                return $types;
+        }
+
+}