<!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>[BuddyPress][9924] trunk/src/bp-messages/bp-messages-star.php: Messages: Updates to `bp_get_the_message_star_action_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 { 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="http://buddypress.trac.wordpress.org/changeset/9924">9924</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9924","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-06-11 02:15:18 +0000 (Thu, 11 Jun 2015)</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'>Messages: Updates to `bp_get_the_message_star_action_link()`:
* Set default `$user_id` so links work on displayed users
* Use `switch` vs. `if/else` to make `$user_domain` calculation more obvious
* Bail if `$user_domain` cannot be calculated
* Cast a few variables to avoid non-integer issues cascading into other methods
* Strict boolean comparisons to ensure proper execution
* Escape output of a few HTML attributes
This change allows for the action-link used to star a message to use the correct URL for the `user_id` that's passed into it. This is particularly helpful for capable community moderators that can view other user's Messages, so the links point to the correct URLs for the correct user.
See <a href="http://buddypress.trac.wordpress.org/ticket/6489">#6489</a>. (trunk)</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmessagesbpmessagesstarphp">trunk/src/bp-messages/bp-messages-star.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmessagesbpmessagesstarphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-messages/bp-messages-star.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-messages/bp-messages-star.php 2015-06-10 22:27:27 UTC (rev 9923)
+++ trunk/src/bp-messages/bp-messages-star.php 2015-06-11 02:15:18 UTC (rev 9924)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -88,38 +88,55 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_the_message_star_action_link( $args = array() ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Default user ID
+ $user_id = bp_displayed_user_id()
+ ? bp_displayed_user_id()
+ : bp_loggedin_user_id();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $r = bp_parse_args( $args, array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'user_id' => bp_loggedin_user_id(),
- 'thread_id' => 0,
- 'message_id' => (int) bp_get_the_thread_message_id(),
- 'url_only' => false,
- 'text_unstar' => __( 'Unstar', 'buddypress' ),
- 'text_star' => __( 'Star', 'buddypress' ),
- 'title_unstar' => __( 'Starred', 'buddypress' ),
- 'title_star' => __( 'Not starred', 'buddypress' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_id' => (int) $user_id,
+ 'thread_id' => 0,
+ 'message_id' => (int) bp_get_the_thread_message_id(),
+ 'url_only' => false,
+ 'text_unstar' => __( 'Unstar', 'buddypress' ),
+ 'text_star' => __( 'Star', 'buddypress' ),
+ 'title_unstar' => __( 'Starred', 'buddypress' ),
+ 'title_star' => __( 'Not starred', 'buddypress' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'title_unstar_thread' => __( 'Remove all starred messages in this thread', 'buddypress' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'title_star_thread' => __( 'Star the first message in this thread', 'buddypress' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'title_star_thread' => __( 'Star the first message in this thread', 'buddypress' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ), 'messages_star_action_link' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $retval = $bulk_attr = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check user ID and determine base user URL
+ switch ( $r['user_id'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 0 === $r['user_id'] ) {
- return $retval;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Current user
+ case bp_loggedin_user_id() :
+ $user_domain = bp_loggedin_user_domain();
+ break;
+
+ // Displayed user
+ case bp_displayed_user_id() :
+ $user_domain = bp_displayed_user_domain();
+ break;
+
+ // Empty or other
+ default :
+ $user_domain = bp_core_get_user_domain( $r['user_id'] );
+ break;
</ins><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">- // get user domain
- if ( $r['user_id'] == bp_loggedin_user_id() ) {
- $user_domain = bp_loggedin_user_domain();
- } elseif ( $r['user_id'] == bp_displayed_user_domain() ) {
- $user_domain = bp_displayed_user_domain();
- } else {
- $user_domain = bp_core_get_user_domain( $r['user_id'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Bail if no user domain was calculated
+ if ( empty( $user_domain ) ) {
+ 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"> // thread ID
</span><span class="cx" style="display: block; padding: 0 10px"> if ( (int) $r['thread_id'] > 0 ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // see if we're in the loop
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_get_message_thread_id() == $r['thread_id'] ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // grab all message ids
</span><span class="cx" style="display: block; padding: 0 10px"> $mids = wp_list_pluck( $GLOBALS['messages_template']->thread->messages, 'id' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -129,13 +146,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // pull up the thread
</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">- $thread = new BP_Messages_thread( $r['thread_id'] );
- $mids = wp_list_pluck( $thread->messages, 'id' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $thread = new BP_Messages_Thread( $r['thread_id'] );
+ $mids = wp_list_pluck( $thread->messages, 'id' );
</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"> $is_starred = false;
</span><span class="cx" style="display: block; padding: 0 10px"> $message_id = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $mids as $mid ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // try to find the first msg that is starred in a thread
</span><span class="cx" style="display: block; padding: 0 10px"> if ( true === bp_messages_is_message_starred( $mid ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $is_starred = true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -149,16 +167,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $message_id = $mids[0];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $message_id = (int) $message_id;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // nonce
</span><span class="cx" style="display: block; padding: 0 10px"> $nonce = wp_create_nonce( "bp-messages-star-{$message_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 ( $is_starred ) {
- $action = 'unstar';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( true === $is_starred ) {
+ $action = 'unstar';
</ins><span class="cx" style="display: block; padding: 0 10px"> $bulk_attr = ' data-star-bulk="1"';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $retval = $user_domain . bp_get_messages_slug() . '/unstar/' . $message_id . '/' . $nonce . '/all/';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $retval = $user_domain . bp_get_messages_slug() . '/unstar/' . $message_id . '/' . $nonce . '/all/';
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $action = 'star';
- $retval = $user_domain . bp_get_messages_slug() . '/star/' . $message_id . '/' . $nonce . '/';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $action = 'star';
+ $retval = $user_domain . bp_get_messages_slug() . '/star/' . $message_id . '/' . $nonce . '/';
</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"> $title = $r["title_{$action}_thread"];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -169,7 +189,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $is_starred = bp_messages_is_message_starred( $message_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $nonce = wp_create_nonce( "bp-messages-star-{$message_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 ( $is_starred ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( true === $is_starred ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $action = 'unstar';
</span><span class="cx" style="display: block; padding: 0 10px"> $retval = $user_domain . bp_get_messages_slug() . '/unstar/' . $message_id . '/' . $nonce . '/';
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -201,7 +221,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $retval Link for starring / unstarring a message, including markup.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $r Parsed link arguments. See $args in bp_get_the_message_star_action_link().
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'bp_get_the_message_star_action_link', '<a title="' . esc_attr( $title ) . '" class="message-action-' . $action . '" data-star-status="' . $action .'" data-star-nonce="' . $nonce . '"' . $bulk_attr . ' data-message-id="' . esc_attr( (int) $message_id ) . '" href="' . $retval . '"><span class="icon"></span> <span class="bp-screen-reader-text">' . $r['text_' . $action] . '</span></a>', $r );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'bp_get_the_message_star_action_link', '<a title="' . esc_attr( $title ) . '" class="message-action-' . esc_attr( $action ) . '" data-star-status="' . esc_attr( $action ) .'" data-star-nonce="' . esc_attr( $nonce ) . '"' . $bulk_attr . ' data-message-id="' . esc_attr( (int) $message_id ) . '" href="' . $retval . '"><span class="icon"></span> <span class="bp-screen-reader-text">' . $r['text_' . $action] . '</span></a>', $r );
</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></pre>
</div>
</div>
</body>
</html>