sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Comments: Adjust `comment_author_email_link()` and `get_comment_author_email_link()` to each accept a new optional fourth parameter, `$comment`, which enables overriding the `$comment` global. 

Adds tests.

Props flixos90, boonebgorges, DrewAPicture.
See #36571.


git-svn-id: https://develop.svn.wordpress.org/trunk@37348 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-05-02 19:58:23 +00:00
parent bef15d72a4
commit 0f468dd456
2 changed files with 110 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/wp-includes/comment-template.php
View File

@ -138,16 +138,19 @@ function comment_author_email( $comment_ID = 0 ) {
* address and use it for their own means good and bad. * address and use it for their own means good and bad.
* *
* @since 0.71 * @since 0.71
* @since 4.6.0 The `$comment` parameter was added.
* *
* @param string $linktext Optional. Text to display instead of the comment author's email address. * @param string $linktext Optional. Text to display instead of the comment author's email address.
* Default empty. * Default empty.
* @param string $before Optional. Text or HTML to display before the email link. Default empty. * @param string $before Optional. Text or HTML to display before the email link. Default empty.
* @param string $after Optional. Text or HTML to display after the email link. Default empty. * @param string $after Optional. Text or HTML to display after the email link. Default empty.
* @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
*/ */
function comment_author_email_link( $linktext = '', $before = '', $after = '' ) { function comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
if ( $link = get_comment_author_email_link( $linktext, $before, $after ) ) if ( $link = get_comment_author_email_link( $linktext, $before, $after, $comment ) ) {
echo $link; echo $link;
} }
}
/** /**
* Return the html email link to the author of the current comment. * Return the html email link to the author of the current comment.
@ -159,15 +162,18 @@ function comment_author_email_link( $linktext = '', $before = '', $after = '' )
* address and use it for their own means good and bad. * address and use it for their own means good and bad.
* *
* @since 2.7.0 * @since 2.7.0
* @since 4.6.0 The `$comment` parameter was added.
* *
* @param string $linktext Optional. Text to display instead of the comment author's email address. * @param string $linktext Optional. Text to display instead of the comment author's email address.
* Default empty. * Default empty.
* @param string $before Optional. Text or HTML to display before the email link. Default empty. * @param string $before Optional. Text or HTML to display before the email link. Default empty.
* @param string $after Optional. Text or HTML to display after the email link. Default empty. * @param string $after Optional. Text or HTML to display after the email link. Default empty.
* @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
* @return string * @return string
*/ */
function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) { function get_comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
$comment = get_comment(); $comment = get_comment( $comment );
/** /**
* Filter the comment author's email for display. * Filter the comment author's email for display.
* *
@ -181,6 +187,7 @@ function get_comment_author_email_link( $linktext = '', $before = '', $after = '
* @param WP_Comment $comment The comment object. * @param WP_Comment $comment The comment object.
*/ */
$email = apply_filters( 'comment_email', $comment->comment_author_email, $comment ); $email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );
if ((!empty($email)) && ($email != '@')) { if ((!empty($email)) && ($email != '@')) {
$display = ($linktext != '') ? $linktext : $email; $display = ($linktext != '') ? $linktext : $email;
$return = $before; $return = $before;

99
tests/phpunit/tests/comment/getCommentAuthorEmailLink.php Normal file
View File

@ -0,0 +1,99 @@
<?php
/**
* @group comment
*/
class Tests_Comment_GetCommentAuthorEmailLink extends WP_UnitTestCase {
public static $comment;
public function setUp() {
parent::setUp();
// Fake the 'comment' global.
$GLOBALS['comment'] = self::$comment;
// Remove obfuscation for testing purposes.
remove_filter( 'comment_email', 'antispambot' );
}
public function tearDown() {
unset( $GLOBALS['comment'] );
parent::tearDown();
add_filter( 'comment_email', 'antispambot' );
}
public static function wpSetUpBeforeClass( $factory ) {
self::$comment = $factory->comment->create_and_get( array(
'comment_author_email' => 'foo@example.org'
) );
}
public static function wpTearDownAfterClass() {
wp_delete_comment( self::$comment->comment_ID, true );
}
public function test_global_comment_with_default_parameters() {
$expected = '<a href="mailto:foo@example.org">foo@example.org</a>';
$this->assertEquals( $expected, get_comment_author_email_link() );
}
/**
* @ticket 36571
*/
public function test_all_parameters() {
unset( $GLOBALS['comment'] );
$linktext = rand_str( 10 );
$before = rand_str( 5 );
$after = rand_str( 6 );
$comment = self::factory()->comment->create_and_get( array(
'comment_author_email' => $email = 'baz@example.org'
) );
$expected = sprintf( '%1$s<a href="mailto:%2$s">%3$s</a>%4$s', $before, $email, $linktext, $after );
$this->assertEquals( $expected, get_comment_author_email_link( $linktext, $before, $after, $comment ) );
}
public function test_all_parameters_with_global_comment() {
$linktext = rand_str( 10 );
$before = rand_str( 5 );
$after = rand_str( 6 );
$expected = sprintf( '%1$s<a href="mailto:foo@example.org">%2$s</a>%3$s', $before, $linktext, $after );
$this->assertEquals( $expected, get_comment_author_email_link( $linktext, $before, $after ) );
}
public function test_linktext() {
$expected = sprintf( '<a href="mailto:foo@example.org">%1$s</a>', $linktext = rand_str( 12 ) );
$this->assertEquals( $expected, get_comment_author_email_link( $linktext ) );
}
public function test_before() {
$expected = sprintf( '%1$s<a href="mailto:foo@example.org">foo@example.org</a>', $before = rand_str( 5 ) );
$this->assertEquals( $expected, get_comment_author_email_link( '', $before ) );
}
public function test_after() {
$expected = sprintf( '<a href="mailto:foo@example.org">foo@example.org</a>%1$s', $after = rand_str( 5 ) );
$this->assertEquals( $expected, get_comment_author_email_link( '', '', $after ) );
}
/**
* @ticket 36571
*/
public function test_comment_param_should_override_global() {
$comment = self::factory()->comment->create_and_get( array(
'comment_author_email' => $email = 'bar@example.org'
) );
$expected = sprintf( '<a href="mailto:%1$s">%2$s</a>', $email, $email );
$this->assertEquals( $expected, get_comment_author_email_link( '', '', '', $comment ) );
}
}