<!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][8667] trunk/src/bp-notifications/bp-notifications-template.php: Introduce helper functions to build nonced URL's when marking single notifications as read/unread, for more easily making custom notification links.</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/8667">8667</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2014-07-22 20:44:11 +0000 (Tue, 22 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce helper functions to build nonced URL's when marking single notifications as read/unread, for more easily making custom notification links.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpnotificationsbpnotificationstemplatephp">trunk/src/bp-notifications/bp-notifications-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpnotificationsbpnotificationstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-notifications/bp-notifications-template.php (8666 => 8667)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-notifications/bp-notifications-template.php 2014-07-22 20:31:45 UTC (rev 8666)
+++ trunk/src/bp-notifications/bp-notifications-template.php 2014-07-22 20:44:11 UTC (rev 8667)
</span><span class="lines">@@ -724,13 +724,10 @@
</span><span class="cx"> */
</span><span class="cx"> function bp_get_the_notification_mark_read_link() {
</span><span class="cx">
</span><del>- // Get the URL with nonce, action, and id
- $url = wp_nonce_url( add_query_arg( array( 'action' => 'read', 'notification_id' => bp_get_the_notification_id() ), bp_get_notifications_unread_permalink() ), 'bp_notification_mark_read_' . bp_get_the_notification_id() );
-
</del><span class="cx"> // Start the output buffer
</span><span class="cx"> ob_start(); ?>
</span><span class="cx">
</span><del>- <a href="<?php echo esc_url( $url ); ?>" class="mark-read primary"><?php _e( 'Read', 'buddypress' ); ?></a>
</del><ins>+ <a href="<?php bp_the_notification_mark_read_url(); ?>" class="mark-read primary"><?php _e( 'Read', 'buddypress' ); ?></a>
</ins><span class="cx">
</span><span class="cx"> <?php $retval = ob_get_clean();
</span><span class="cx">
</span><span class="lines">@@ -738,6 +735,44 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Output the URL used for marking a single notification as read
+ *
+ * Since this function directly outputs a URL, it is escaped.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @uses bp_get_the_notification_mark_read_url()
+ */
+function bp_the_notification_mark_read_url() {
+ echo esc_url( bp_get_the_notification_mark_read_url() );
+}
+ /**
+ * Return the URL used for marking a single notification as read
+ *
+ * @since BuddyPress (2.1.0)
+ */
+ function bp_get_the_notification_mark_read_url() {
+
+ // Get the notification ID
+ $id = bp_get_the_notification_id();
+
+ // Get the args to add to the URL
+ $args = array(
+ 'action' => 'read',
+ 'notification_id' => $id
+ );
+
+ // Add the args to the URL
+ $url = add_query_arg( $args, bp_get_notifications_unread_permalink() );
+
+ // Add the nonce
+ $url = wp_nonce_url( $url, 'bp_notification_mark_read_' . $id );
+
+ // Filter and return
+ return apply_filters( 'bp_get_the_notification_mark_read_url', $url );
+ }
+
+/**
</ins><span class="cx"> * Output the mark read link for the current notification.
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.9.0)
</span><span class="lines">@@ -754,13 +789,10 @@
</span><span class="cx"> */
</span><span class="cx"> function bp_get_the_notification_mark_unread_link() {
</span><span class="cx">
</span><del>- // Get the URL with nonce, action, and id
- $url = wp_nonce_url( add_query_arg( array( 'action' => 'unread', 'notification_id' => bp_get_the_notification_id() ), bp_get_notifications_read_permalink() ), 'bp_notification_mark_unread_' . bp_get_the_notification_id() );
-
</del><span class="cx"> // Start the output buffer
</span><span class="cx"> ob_start(); ?>
</span><span class="cx">
</span><del>- <a href="<?php echo esc_url( $url ); ?>" class="mark-unread primary"><?php _e( 'Unread', 'buddypress' ); ?></a>
</del><ins>+ <a href="<?php bp_the_notification_mark_unread_url(); ?>" class="mark-unread primary"><?php _e( 'Unread', 'buddypress' ); ?></a>
</ins><span class="cx">
</span><span class="cx"> <?php $retval = ob_get_clean();
</span><span class="cx">
</span><span class="lines">@@ -768,6 +800,44 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Output the URL used for marking a single notification as unread
+ *
+ * Since this function directly outputs a URL, it is escaped.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @uses bp_get_the_notification_mark_unread_url()
+ */
+function bp_the_notification_mark_unread_url() {
+ echo esc_url( bp_get_the_notification_mark_unread_url() );
+}
+ /**
+ * Return the URL used for marking a single notification as unread
+ *
+ * @since BuddyPress (2.1.0)
+ */
+ function bp_get_the_notification_mark_unread_url() {
+
+ // Get the notification ID
+ $id = bp_get_the_notification_id();
+
+ // Get the args to add to the URL
+ $args = array(
+ 'action' => 'unread',
+ 'notification_id' => $id
+ );
+
+ // Add the args to the URL
+ $url = add_query_arg( $args, bp_get_notifications_read_permalink() );
+
+ // Add the nonce
+ $url = wp_nonce_url( $url, 'bp_notification_mark_unread_' . $id );
+
+ // Filter and return
+ return apply_filters( 'bp_get_the_notification_mark_unread_url', $url );
+ }
+
+/**
</ins><span class="cx"> * Output the mark link for the current notification.
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.9.0)
</span><span class="lines">@@ -849,17 +919,20 @@
</span><span class="cx"> $link = bp_get_notifications_read_permalink();
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Args to add to the link
</del><ins>+ // Get the ID
+ $id = bp_get_the_notification_id();
+
+ // Get the args to add to the URL
</ins><span class="cx"> $args = array(
</span><span class="cx"> 'action' => 'delete',
</span><del>- 'notification_id' => bp_get_the_notification_id()
</del><ins>+ 'notification_id' => $id
</ins><span class="cx"> );
</span><span class="cx">
</span><span class="cx"> // Add the args
</span><span class="cx"> $url = add_query_arg( $args, $link );
</span><span class="cx">
</span><span class="cx"> // Add the nonce
</span><del>- $url = wp_nonce_url( $url, 'bp_notification_delete_' . bp_get_the_notification_id() );
</del><ins>+ $url = wp_nonce_url( $url, 'bp_notification_delete_' . $id );
</ins><span class="cx">
</span><span class="cx"> // Filter and return
</span><span class="cx"> return apply_filters( 'bp_get_the_notification_delete_url', $url );
</span></span></pre>
</div>
</div>
</body>
</html>