<!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>[57123] trunk/src/wp-admin/includes: Coding Standards: Rewrite a few capability checks for clarity and readability.</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/57123">57123</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/57123","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>2023-11-17 17:09:09 +0000 (Fri, 17 Nov 2023)</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'>Coding Standards: Rewrite a few capability checks for clarity and readability.
This aims to:
* Perform the checks as early as possible to avoid redundant function calls.
* Remove an empty conditiaonal branch and make the exit conditions clearer.
* Bring the formatting in line with other multi-line conditionals in core.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/56836">[56836]</a>.
See <a href="https://core.trac.wordpress.org/ticket/59650">#59650</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpcommentslisttablephp">trunk/src/wp-admin/includes/class-wp-comments-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswplisttablephp">trunk/src/wp-admin/includes/class-wp-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesdashboardphp">trunk/src/wp-admin/includes/dashboard.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpcommentslisttablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-comments-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-comments-list-table.php 2023-11-17 16:20:50 UTC (rev 57122)
+++ trunk/src/wp-admin/includes/class-wp-comments-list-table.php 2023-11-17 17:09:09 UTC (rev 57123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -638,8 +638,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function single_row( $item ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $post, $comment;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Restores the more descriptive, specific name for use within this method.
</ins><span class="cx" style="display: block; padding: 0 10px"> $comment = $item;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $comment->comment_post_ID > 0 ) {
+ $post = get_post( $comment->comment_post_ID );
+ }
+
+ $edit_post_cap = $post ? 'edit_post' : 'edit_posts';
+
+ if ( ! current_user_can( $edit_post_cap, $comment->comment_post_ID )
+ && ( ! empty( $post->post_password )
+ || ! current_user_can( 'read_post', $comment->comment_post_ID ) )
+ ) {
+ // The user has no access to the post and thus cannot see the comments.
+ return false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $the_comment_class = wp_get_comment_status( $comment );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $the_comment_class ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -648,25 +663,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $the_comment_class = implode( ' ', get_comment_class( $the_comment_class, $comment, $comment->comment_post_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">- if ( $comment->comment_post_ID > 0 ) {
- $post = get_post( $comment->comment_post_ID );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->user_can = current_user_can( 'edit_comment', $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">- $edit_post_cap = $post ? 'edit_post' : 'edit_posts';
- if (
- current_user_can( $edit_post_cap, $comment->comment_post_ID ) ||
- (
- empty( $post->post_password ) &&
- current_user_can( 'read_post', $comment->comment_post_ID )
- )
- ) {
- // The user has access to the post and thus can see comments.
- } else {
- return false;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> echo "<tr id='comment-$comment->comment_ID' class='$the_comment_class'>";
</span><span class="cx" style="display: block; padding: 0 10px"> $this->single_row_columns( $comment );
</span><span class="cx" style="display: block; padding: 0 10px"> echo "</tr>\n";
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswplisttablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-list-table.php 2023-11-17 16:20:50 UTC (rev 57122)
+++ trunk/src/wp-admin/includes/class-wp-list-table.php 2023-11-17 17:09:09 UTC (rev 57123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -828,6 +828,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $pending_comments Number of pending comments.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function comments_bubble( $post_id, $pending_comments ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_object = get_post( $post_id );
+ $edit_post_cap = $post_object ? 'edit_post' : 'edit_posts';
+
+ if ( ! current_user_can( $edit_post_cap, $post_id )
+ && ( ! empty( $post_object->post_password )
+ || ! current_user_can( 'read_post', $post_id ) )
+ ) {
+ // The user has no access to the post and thus cannot see the comments.
+ return false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $approved_comments = get_comments_number();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $approved_comments_number = number_format_i18n( $approved_comments );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -851,20 +862,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $pending_comments_number
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $post_object = get_post( $post_id );
- $edit_post_cap = $post_object ? 'edit_post' : 'edit_posts';
- if (
- current_user_can( $edit_post_cap, $post_id ) ||
- (
- empty( $post_object->post_password ) &&
- current_user_can( 'read_post', $post_id )
- )
- ) {
- // The user has access to the post and thus can see comments.
- } else {
- return false;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! $approved_comments && ! $pending_comments ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // No comments at all.
</span><span class="cx" style="display: block; padding: 0 10px"> printf(
</span></span></pre></div>
<a id="trunksrcwpadminincludesdashboardphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/dashboard.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/dashboard.php 2023-11-17 16:20:50 UTC (rev 57122)
+++ trunk/src/wp-admin/includes/dashboard.php 2023-11-17 17:09:09 UTC (rev 57123)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1088,7 +1088,13 @@
</span><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"> foreach ( $possible as $comment ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! current_user_can( 'read_post', $comment->comment_post_ID ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_post = get_post( $comment->comment_post_ID );
+
+ if ( ! current_user_can( 'edit_post', $comment->comment_post_ID )
+ && ( ! empty( $comment_post->post_password )
+ || ! current_user_can( 'read_post', $comment->comment_post_ID ) )
+ ) {
+ // The user has no access to the post and thus cannot see the comments.
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">@@ -1109,16 +1115,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> echo '<ul id="the-comment-list" data-wp-lists="list:comment">';
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $comments as $comment ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $comment_post = get_post( $comment->comment_post_ID );
- if (
- current_user_can( 'edit_post', $comment->comment_post_ID ) ||
- (
- empty( $comment_post->post_password ) &&
- current_user_can( 'read_post', $comment->comment_post_ID )
- )
- ) {
- _wp_dashboard_recent_comments_row( $comment );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _wp_dashboard_recent_comments_row( $comment );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> echo '</ul>';
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>