<!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>[47059] trunk/src/wp-admin/includes: Docs: Synchronize `@return` descriptions for `::handle_row_actions()` methods in list tables.</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/47059">47059</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/47059","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>2020-01-11 17:56:15 +0000 (Sat, 11 Jan 2020)</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'>Docs: Synchronize `@return` descriptions for `::handle_row_actions()` methods in list tables.
Make sure `WP_Comments_List_Table::handle_row_actions()` and `WP_MS_Sites_List_Table::handle_row_actions()` return a string, for consistency with other classes.
See <a href="https://core.trac.wordpress.org/ticket/49170">#49170</a>, <a href="https://core.trac.wordpress.org/ticket/48303">#48303</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="#trunksrcwpadminincludesclasswplinkslisttablephp">trunk/src/wp-admin/includes/class-wp-links-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpmedialisttablephp">trunk/src/wp-admin/includes/class-wp-media-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpmssiteslisttablephp">trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpmsuserslisttablephp">trunk/src/wp-admin/includes/class-wp-ms-users-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswppostslisttablephp">trunk/src/wp-admin/includes/class-wp-posts-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswptermslisttablephp">trunk/src/wp-admin/includes/class-wp-terms-list-table.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 2020-01-11 17:55:49 UTC (rev 47058)
+++ trunk/src/wp-admin/includes/class-wp-comments-list-table.php 2020-01-11 17:56:15 UTC (rev 47059)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -576,7 +576,9 @@
</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"> * @param string $column_name Current column name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $primary Primary column name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string|void Comment row actions output.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Row actions output for comments. An empty string
+ * if the current column is not the primary column,
+ * or if the current user cannot edit the comment.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_row_actions( $comment, $column_name, $primary ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $comment_status;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -586,7 +588,7 @@
</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"> if ( ! $this->user_can ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return '';
</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"> $the_comment_status = wp_get_comment_status( $comment );
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswplinkslisttablephp"></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-links-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-links-list-table.php 2020-01-11 17:55:49 UTC (rev 47058)
+++ trunk/src/wp-admin/includes/class-wp-links-list-table.php 2020-01-11 17:56:15 UTC (rev 47059)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -314,7 +314,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $link Link being acted upon.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $column_name Current column name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $primary Primary column name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Row action output for links.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Row actions output for links, or an empty string
+ * if the current column is not the primary column.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_row_actions( $link, $column_name, $primary ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $primary !== $column_name ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpmedialisttablephp"></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-media-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-media-list-table.php 2020-01-11 17:55:49 UTC (rev 47058)
+++ trunk/src/wp-admin/includes/class-wp-media-list-table.php 2020-01-11 17:56:15 UTC (rev 47059)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -781,7 +781,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $post Attachment being acted upon.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $column_name Current column name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $primary Primary column name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Row actions output for media attachments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Row actions output for media attachments, or an empty string
+ * if the current column is not the primary column.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_row_actions( $post, $column_name, $primary ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $primary !== $column_name ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -789,6 +790,7 @@
</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"> $att_title = _draft_or_post_title();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $this->row_actions( $this->_get_row_actions( $post, $att_title ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpmssiteslisttablephp"></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-ms-sites-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-ms-sites-list-table.php 2020-01-11 17:55:49 UTC (rev 47058)
+++ trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php 2020-01-11 17:56:15 UTC (rev 47059)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -666,11 +666,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $blog Site being acted upon.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $column_name Current column name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $primary Primary column name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Row actions output.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Row actions output for sites in Multisite, or an empty string
+ * if the current column is not the primary column.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_row_actions( $blog, $column_name, $primary ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $primary !== $column_name ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return '';
</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"> $blogname = untrailingslashit( $blog['domain'] . $blog['path'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -733,6 +734,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * or subdirectory multisite installation.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $actions = apply_filters( 'manage_sites_action_links', array_filter( $actions ), $blog['blog_id'], $blogname );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $this->row_actions( $actions );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpmsuserslisttablephp"></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-ms-users-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-ms-users-list-table.php 2020-01-11 17:55:49 UTC (rev 47058)
+++ trunk/src/wp-admin/includes/class-wp-ms-users-list-table.php 2020-01-11 17:56:15 UTC (rev 47059)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -488,7 +488,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $user User being acted upon.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $column_name Current column name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $primary Primary column name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Row actions output for users in Multisite.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Row actions output for users in Multisite, or an empty string
+ * if the current column is not the primary column.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_row_actions( $user, $column_name, $primary ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $primary !== $column_name ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -517,6 +518,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_User $user WP_User object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $actions = apply_filters( 'ms_user_row_actions', $actions, $user );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $this->row_actions( $actions );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswppostslisttablephp"></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-posts-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-posts-list-table.php 2020-01-11 17:55:49 UTC (rev 47058)
+++ trunk/src/wp-admin/includes/class-wp-posts-list-table.php 2020-01-11 17:56:15 UTC (rev 47059)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1320,7 +1320,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $post Post being acted upon.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $column_name Current column name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $primary Primary column name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Row actions output for posts.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Row actions output for posts, or an empty string
+ * if the current column is not the primary column.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_row_actions( $post, $column_name, $primary ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $primary !== $column_name ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswptermslisttablephp"></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-terms-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-terms-list-table.php 2020-01-11 17:55:49 UTC (rev 47058)
+++ trunk/src/wp-admin/includes/class-wp-terms-list-table.php 2020-01-11 17:56:15 UTC (rev 47059)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -446,7 +446,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Term $tag Tag being acted upon.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $column_name Current column name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $primary Primary column name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Row actions output for terms.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Row actions output for terms, or an empty string
+ * if the current column is not the primary column.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_row_actions( $tag, $column_name, $primary ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $primary !== $column_name ) {
</span></span></pre>
</div>
</div>
</body>
</html>