<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[37348] trunk: 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.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/37348">37348</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/37348","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-05-02 19:58:23 +0000 (Mon, 02 May 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/36571">#36571</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestscommentgetCommentAuthorEmailLinkphp">trunk/tests/phpunit/tests/comment/getCommentAuthorEmailLink.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommenttemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/comment-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment-template.php 2016-05-02 19:52:01 UTC (rev 37347)
+++ trunk/src/wp-includes/comment-template.php 2016-05-02 19:58:23 UTC (rev 37348)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -138,15 +138,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * address and use it for their own means good and bad.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 0.71
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.6.0 The `$comment` parameter was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $linktext Optional. Text to display instead of the comment author's email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $before Optional. Text or HTML to display before the email link. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $after Optional. Text or HTML to display after the email link. Default empty.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
- if ( $link = get_comment_author_email_link( $linktext, $before, $after ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
+ if ( $link = get_comment_author_email_link( $linktext, $before, $after, $comment ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> echo $link;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,15 +162,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * address and use it for their own means good and bad.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.6.0 The `$comment` parameter was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $linktext Optional. Text to display instead of the comment author's email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $before Optional. Text or HTML to display before the email link. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $after Optional. Text or HTML to display after the email link. Default empty.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
- $comment = get_comment();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
+ $comment = get_comment( $comment );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter the comment author's email for display.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -181,6 +187,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Comment $comment The comment object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ((!empty($email)) && ($email != '@')) {
</span><span class="cx" style="display: block; padding: 0 10px"> $display = ($linktext != '') ? $linktext : $email;
</span><span class="cx" style="display: block; padding: 0 10px"> $return = $before;
</span></span></pre></div>
<a id="trunktestsphpunittestscommentgetCommentAuthorEmailLinkphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/comment/getCommentAuthorEmailLink.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/getCommentAuthorEmailLink.php (rev 0)
+++ trunk/tests/phpunit/tests/comment/getCommentAuthorEmailLink.php 2016-05-02 19:58:23 UTC (rev 37348)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,99 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?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 ) );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>