<!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][7543] trunk/bp-notifications: Introduce `bp-notifications-actions.php` to handle single notification status toggling.</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/7543">7543</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2013-11-09 13:59:32 +0000 (Sat, 09 Nov 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce `bp-notifications-actions.php` to handle single notification status toggling.
* Include new actions file in loader.
* Tweak link output functions to make it moderately easier to debug the URL.
* Introduce `bp_notifications_mark_notification()` to help with marking single notifications.
* Fix `bp_notifications_delete_notification()` to work with new array argument pattern, introduced previously.
* It's alive!
See <a href="http://buddypress.trac.wordpress.org/ticket/5148">#5148</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpnotificationsbpnotificationsfunctionsphp">trunk/bp-notifications/bp-notifications-functions.php</a></li>
<li><a href="#trunkbpnotificationsbpnotificationsloaderphp">trunk/bp-notifications/bp-notifications-loader.php</a></li>
<li><a href="#trunkbpnotificationsbpnotificationstemplatephp">trunk/bp-notifications/bp-notifications-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkbpnotificationsbpnotificationsactionsphp">trunk/bp-notifications/bp-notifications-actions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpnotificationsbpnotificationsactionsphp"></a>
<div class="addfile"><h4>Added: trunk/bp-notifications/bp-notifications-actions.php (0 => 7543)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-notifications/bp-notifications-actions.php (rev 0)
+++ trunk/bp-notifications/bp-notifications-actions.php 2013-11-09 13:59:32 UTC (rev 7543)
</span><span class="lines">@@ -0,0 +1,123 @@
</span><ins>+<?php
+
+/**
+ * BuddyPress Notifications Actions
+ *
+ * Action functions are exactly the same as screen functions, however they do not
+ * have a template screen associated with them. Usually they will send the user
+ * back to the default screen after execution.
+ *
+ * @package BuddyPress
+ * @subpackage NotificationsActions
+ */
+
+// Exit if accessed directly
+if ( !defined( 'ABSPATH' ) ) exit;
+
+/**
+ * Handle marking single notifications as read
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @return boolean
+ */
+function bp_notifications_action_mark_read() {
+
+ // Bail if not the unread screen
+ if ( ! bp_is_notifications_component() || ! bp_is_current_action( 'unread' ) ) {
+ return false;
+ }
+
+ // Get the action
+ $action = !empty( $_GET['action'] ) ? $_GET['action'] : '';
+ $nonce = !empty( $_GET['_wpnonce'] ) ? $_GET['_wpnonce'] : '';
+ $id = !empty( $_GET['notification_id'] ) ? $_GET['notification_id'] : '';
+
+ // Bail if no action or no ID
+ if ( ( 'read' !== $action ) || empty( $id ) || empty( $nonce ) ) {
+ return false;
+ }
+
+ // Check the nonce and mark the notification
+ if ( bp_verify_nonce_request( 'bp_notification_mark_read_' . $id ) && bp_notifications_mark_notification( $id, false ) ) {
+ bp_core_add_message( __( 'Notification successfully marked read.', 'buddypress' ) );
+ } else {
+ bp_core_add_message( __( 'There was a problem marking that notification.', 'buddypress' ), 'error' );
+ }
+
+ // Redirect
+ bp_core_redirect( bp_displayed_user_domain() . bp_get_notifications_slug() . '/unread/' );
+}
+add_action( 'bp_actions', 'bp_notifications_action_mark_read' );
+
+/**
+ * Handle marking single notifications as unread
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @return boolean
+ */
+function bp_notifications_action_mark_unread() {
+
+ // Bail if not the unread screen
+ if ( ! bp_is_notifications_component() || ! bp_is_current_action( 'read' ) ) {
+ return false;
+ }
+
+ // Get the action
+ $action = !empty( $_GET['action'] ) ? $_GET['action'] : '';
+ $nonce = !empty( $_GET['_wpnonce'] ) ? $_GET['_wpnonce'] : '';
+ $id = !empty( $_GET['notification_id'] ) ? $_GET['notification_id'] : '';
+
+ // Bail if no action or no ID
+ if ( ( 'unread' !== $action ) || empty( $id ) || empty( $nonce ) ) {
+ return false;
+ }
+
+ // Check the nonce and mark the notification
+ if ( bp_verify_nonce_request( 'bp_notification_mark_unread_' . $id ) && bp_notifications_mark_notification( $id, true ) ) {
+ bp_core_add_message( __( 'Notification successfully marked unread.', 'buddypress' ) );
+ } else {
+ bp_core_add_message( __( 'There was a problem marking that notification.', 'buddypress' ), 'error' );
+ }
+
+ // Redirect
+ bp_core_redirect( bp_displayed_user_domain() . bp_get_notifications_slug() . '/read/' );
+}
+add_action( 'bp_actions', 'bp_notifications_action_mark_unread' );
+
+/**
+ * Handle marking single notifications as unread
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @return boolean
+ */
+function bp_notifications_action_delete() {
+
+ // Bail if not the unread screen
+ if ( ! bp_is_notifications_component() || ! ( bp_is_current_action( 'read' ) || bp_is_current_action( 'unread' ) ) ) {
+ return false;
+ }
+
+ // Get the action
+ $action = !empty( $_GET['action'] ) ? $_GET['action'] : '';
+ $nonce = !empty( $_GET['_wpnonce'] ) ? $_GET['_wpnonce'] : '';
+ $id = !empty( $_GET['notification_id'] ) ? $_GET['notification_id'] : '';
+
+ // Bail if no action or no ID
+ if ( ( 'delete' !== $action ) || empty( $id ) || empty( $nonce ) ) {
+ return false;
+ }
+
+ // Check the nonce and delete the notification
+ if ( bp_verify_nonce_request( 'bp_notification_delete_' . $id ) && bp_notifications_delete_notification( $id ) ) {
+ bp_core_add_message( __( 'Notification successfully deleted.', 'buddypress' ) );
+ } else {
+ bp_core_add_message( __( 'There was a problem deleting that notification.', 'buddypress' ), 'error' );
+ }
+
+ // Redirect
+ bp_core_redirect( bp_displayed_user_domain() . bp_get_notifications_slug() . '/' . bp_current_action() . '/' );
+}
+add_action( 'bp_actions', 'bp_notifications_action_delete' );
</ins></span></pre></div>
<a id="trunkbpnotificationsbpnotificationsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-notifications/bp-notifications-functions.php (7542 => 7543)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-notifications/bp-notifications-functions.php 2013-11-09 13:30:04 UTC (rev 7542)
+++ trunk/bp-notifications/bp-notifications-functions.php 2013-11-09 13:59:32 UTC (rev 7543)
</span><span class="lines">@@ -83,10 +83,32 @@
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- return BP_Notifications_Notification::delete( $id );
</del><ins>+ return BP_Notifications_Notification::delete( array( 'id' => $id ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Mark notification read/unread for a user by ID.
+ *
+ * Used when clearing out notifications for a specific notification item.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @param int $user_id ID of the user whose notifications are being deleted.
+ * @param int $is_new 0 for read, 1 for unread
+ * @return bool True on success, false on failure.
+ */
+function bp_notifications_mark_notification( $id, $is_new = false ) {
+ if ( ! bp_notifications_check_notification_access( bp_loggedin_user_id(), $id ) ) {
+ return false;
+ }
+
+ return BP_Notifications_Notification::update(
+ array( 'is_new' => $is_new ),
+ array( 'id' => $id )
+ );
+}
+
+/**
</ins><span class="cx"> * Get notifications for a specific user.
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.9.0)
</span></span></pre></div>
<a id="trunkbpnotificationsbpnotificationsloaderphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-notifications/bp-notifications-loader.php (7542 => 7543)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-notifications/bp-notifications-loader.php 2013-11-09 13:30:04 UTC (rev 7542)
+++ trunk/bp-notifications/bp-notifications-loader.php 2013-11-09 13:59:32 UTC (rev 7543)
</span><span class="lines">@@ -42,6 +42,7 @@
</span><span class="cx"> */
</span><span class="cx"> public function includes( $includes = array() ) {
</span><span class="cx"> $includes = array(
</span><ins>+ 'actions',
</ins><span class="cx"> 'classes',
</span><span class="cx"> 'screens',
</span><span class="cx"> 'adminbar',
</span></span></pre></div>
<a id="trunkbpnotificationsbpnotificationstemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-notifications/bp-notifications-template.php (7542 => 7543)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-notifications/bp-notifications-template.php 2013-11-09 13:30:04 UTC (rev 7542)
+++ trunk/bp-notifications/bp-notifications-template.php 2013-11-09 13:59:32 UTC (rev 7543)
</span><span class="lines">@@ -660,9 +660,13 @@
</span><span class="cx"> */
</span><span class="cx"> function bp_get_the_notification_mark_read_link() {
</span><span class="cx">
</span><ins>+ // 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() );
+
+ // Start the output buffer
</ins><span class="cx"> ob_start(); ?>
</span><span class="cx">
</span><del>- <a href="<?php echo wp_nonce_url( add_query_arg( array( 'action' => 'read', 'id' => bp_get_the_notification_id() ), bp_get_notifications_unread_permalink() ), 'bp_notification_' . bp_get_the_notification_id() ); ?>" class="mark-read primary"><?php _e( 'Read', 'buddypress' ); ?></a>
</del><ins>+ <a href="<?php echo esc_url( $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">@@ -686,9 +690,13 @@
</span><span class="cx"> */
</span><span class="cx"> function bp_get_the_notification_mark_unread_link() {
</span><span class="cx">
</span><ins>+ // 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() );
+
+ // Start the output buffer
</ins><span class="cx"> ob_start(); ?>
</span><span class="cx">
</span><del>- <a href="<?php echo wp_nonce_url( add_query_arg( array( 'action' => 'unread', 'id' => bp_get_the_notification_id() ), bp_get_notifications_read_permalink() ), 'bp_notification_' . bp_get_the_notification_id() ); ?>" class="mark-unread primary"><?php _e( 'Unread', 'buddypress' ); ?></a>
</del><ins>+ <a href="<?php echo esc_url( $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">@@ -745,10 +753,13 @@
</span><span class="cx"> $link = bp_get_notifications_read_permalink();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Get the URL with nonce, action, and id
+ $url = wp_nonce_url( add_query_arg( array( 'action' => 'delete', 'notification_id' => bp_get_the_notification_id() ), $link ), 'bp_notification_delete_' . bp_get_the_notification_id() );
+
</ins><span class="cx"> // Start the output buffer
</span><span class="cx"> ob_start(); ?>
</span><span class="cx">
</span><del>- <a href="<?php echo wp_nonce_url( add_query_arg( array( 'action' => 'delete', 'id' => bp_get_the_notification_id() ), $link ), 'bp_notification_' . bp_get_the_notification_id() ); ?>" class="delete secondary"><?php _e( 'Delete', 'buddypress' ); ?></a>
</del><ins>+ <a href="<?php echo esc_url( $url ); ?>" class="delete secondary"><?php _e( 'Delete', 'buddypress' ); ?></a>
</ins><span class="cx">
</span><span class="cx"> <?php $retval = ob_get_clean();
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>