<!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>[58809] trunk: Comments: Only type cast a scalar `$comment_id` in `get_comment_author_link()`.</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 { white-space: pre-line; 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/58809">58809</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/58809","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-07-25 22:36:13 +0000 (Thu, 25 Jul 2024)</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: Only type cast a scalar `$comment_id` in `get_comment_author_link()`.
This aims to resolve a fatal error when the incoming `$comment_id` is an instance of `WP_Comment` (or any object) without a `comment_ID` property defined, or if it's empty:
{{{
Object of class WP_Comment could not be converted to string
}}}
This commit mirrors the changes previously made for a similar code fragment in `get_comment_author()`.
Includes:
* Unit tests to demonstrate the fatal error and validate the fix.
* Changing the default value for a non-existent comment ID in `get_comment_author()` from an empty string to zero as a numeric string, for consistency with `get_comment_ID()`.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/52818">[52818]</a>, <a href="https://core.trac.wordpress.org/changeset/55289">[55289]</a>, <a href="https://core.trac.wordpress.org/changeset/58335">[58335]</a>, <a href="https://core.trac.wordpress.org/changeset/58755">[58755]</a>.
Props narenin, mukesh27, iflairwebtechnologies, umeshsinghin, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/61715">#61715</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="#trunktestsphpunittestscommentgetCommentAuthorLinkphp">trunk/tests/phpunit/tests/comment/getCommentAuthorLink.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 2024-07-25 16:33:50 UTC (rev 58808)
+++ trunk/src/wp-includes/comment-template.php 2024-07-25 22:36:13 UTC (rev 58809)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,7 +29,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_scalar( $comment_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_id = (string) $comment_id;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $comment_id = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_id = '0';
</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"> if ( empty( $comment->comment_author ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -233,7 +233,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function get_comment_author_link( $comment_id = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $comment = get_comment( $comment_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $comment_id = ! empty( $comment->comment_ID ) ? $comment->comment_ID : (string) $comment_id;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $comment->comment_ID ) ) {
+ $comment_id = $comment->comment_ID;
+ } elseif ( is_scalar( $comment_id ) ) {
+ $comment_id = (string) $comment_id;
+ } else {
+ $comment_id = '0';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_author_url = get_comment_author_url( $comment );
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_author = get_comment_author( $comment );
</span></span></pre></div>
<a id="trunktestsphpunittestscommentgetCommentAuthorLinkphp"></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/getCommentAuthorLink.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/getCommentAuthorLink.php (rev 0)
+++ trunk/tests/phpunit/tests/comment/getCommentAuthorLink.php 2024-07-25 22:36:13 UTC (rev 58809)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,116 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group comment
+ *
+ * @covers ::get_comment_author_link
+ */
+class Tests_Comment_GetCommentAuthorLink extends WP_UnitTestCase {
+
+ private static $comment;
+ private static $non_existent_comment_id;
+
+ public static function set_up_before_class() {
+ parent::set_up_before_class();
+
+ self::$comment = self::factory()->comment->create_and_get(
+ array(
+ 'comment_post_ID' => 0,
+ )
+ );
+ }
+
+ public function get_comment_author_link_filter( $comment_author_link, $comment_author, $comment_id ) {
+ $this->assertSame( $comment_id, self::$comment->comment_ID, 'Comment IDs do not match.' );
+ $this->assertIsString( $comment_id, '$comment_id parameter is not a string.' );
+
+ return $comment_author_link;
+ }
+
+ public function test_comment_author_link_passes_correct_comment_id_for_comment_object() {
+ add_filter( 'get_comment_author_link', array( $this, 'get_comment_author_link_filter' ), 99, 3 );
+
+ get_comment_author_link( self::$comment );
+ }
+
+ public function test_comment_author_link_passes_correct_comment_id_for_int() {
+ add_filter( 'get_comment_author_link', array( $this, 'get_comment_author_link_filter' ), 99, 3 );
+
+ get_comment_author_link( (int) self::$comment->comment_ID );
+ }
+
+ public function get_comment_author_link_filter_non_existent_id( $comment_author_link, $comment_author, $comment_id ) {
+ $this->assertSame( $comment_id, (string) self::$non_existent_comment_id, 'Comment IDs do not match.' );
+ $this->assertIsString( $comment_id, '$comment_id parameter is not a string.' );
+
+ return $comment_author_link;
+ }
+
+ /**
+ * @ticket 60475
+ */
+ public function test_comment_author_link_passes_correct_comment_id_for_non_existent_comment() {
+ add_filter( 'get_comment_author_link', array( $this, 'get_comment_author_link_filter_non_existent_id' ), 99, 3 );
+
+ self::$non_existent_comment_id = self::$comment->comment_ID + 1;
+
+ get_comment_author_link( self::$non_existent_comment_id ); // Non-existent comment ID.
+ }
+
+ /**
+ * @ticket 61681
+ * @ticket 61715
+ *
+ * @dataProvider data_should_return_author_when_given_object_without_comment_id
+ *
+ * @param stdClass $comment_props Comment properties test data.
+ * @param string $expected The expected result.
+ * @param array $user_data Optional. User data for creating an author. Default empty array.
+ */
+ public function test_should_return_author_when_given_object_without_comment_id( $comment_props, $expected, $user_data = array() ) {
+ if ( ! empty( $comment_props->user_id ) ) {
+ $user = self::factory()->user->create_and_get( $user_data );
+ $comment_props->user_id = $user->ID;
+ }
+
+ $comment = new WP_Comment( $comment_props );
+
+ $this->assertSame( $expected, get_comment_author_link( $comment ) );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_should_return_author_when_given_object_without_comment_id() {
+ return array(
+ 'with no author' => array(
+ 'comment_props' => new stdClass(),
+ 'expected' => 'Anonymous',
+ ),
+ 'with author name' => array(
+ 'comment_props' => (object) array(
+ 'comment_author' => 'tester1',
+ ),
+ 'expected' => 'tester1',
+ ),
+ 'with author name, empty ID' => array(
+ 'comment_props' => (object) array(
+ 'comment_author' => 'tester2',
+ 'comment_ID' => '',
+ ),
+ 'expected' => 'tester2',
+ ),
+ 'with author ID' => array(
+ 'comment_props' => (object) array(
+ 'user_id' => 1, // Populates in the test with an actual user ID.
+ ),
+ 'expected' => 'Tester3',
+ 'user_data' => array(
+ 'display_name' => 'Tester3',
+ ),
+ ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/comment/getCommentAuthorLink.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>