<!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][9079] trunk/src/bp-activity/bp-activity-actions.php: Hook documentation for bp-activity-actions.php.</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/9079">9079</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/9079","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-10-11 16:08:29 +0000 (Sat, 11 Oct 2014)</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'>Hook documentation for bp-activity-actions.php.
Props tw2113, espellcaste.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5936">#5936</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivityactionsphp">trunk/src/bp-activity/bp-activity-actions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivityactionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-actions.php 2014-10-11 01:08:07 UTC (rev 9078)
+++ trunk/src/bp-activity/bp-activity-actions.php 2014-10-11 16:08:29 UTC (rev 9079)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,11 +15,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Allow core components and dependent plugins to register activity actions.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.2)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.2.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses do_action() To call 'bp_register_activity_actions' hook.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_register_activity_actions() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires on bp_init to allow core components and dependent plugins to register activity actions.
+ *
+ * @since BuddyPress (1.2.0)
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_register_activity_actions' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_init', 'bp_register_activity_actions', 8 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,7 +102,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect = add_query_arg( urlencode_deep( $query_frags ), $redirect );
</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">- // Allow redirect to be filtered
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filter the intended redirect url before the redirect occurs for the single activity item.
+ *
+ * @since BuddyPress (1.2.2)
+ *
+ * @param array Array with url to redirect to and activity related to the redirect.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $redirect = apply_filters_ref_array( 'bp_activity_permalink_redirect_url', array( $redirect, &$activity ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> bp_core_redirect( bp_get_root_domain() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -149,7 +161,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! bp_activity_user_can_delete( $activity ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Call the action before the delete so plugins can still fetch information about it
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before the deletion so plugins can still fetch information about it.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param int $activity_id The activity ID.
+ * @param int $user_id The user associated with the activity.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_activity_before_action_delete_activity', $activity_id, $activity->user_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Delete the activity item and provide user feedback
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -158,6 +177,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> else
</span><span class="cx" style="display: block; padding: 0 10px"> bp_core_add_message( __( 'There was an error when deleting that activity', 'buddypress' ), 'error' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after the deletion so plugins can act afterwards based on the activity.
+ *
+ * @since BuddyPress (1.1.0)
+ *
+ * @param int $activity_id The activity ID.
+ * @param int $user_id The user associated with the activity.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_activity_action_delete_activity', $activity_id, $activity->user_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check for the redirect query arg, otherwise let WP handle things
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -203,7 +230,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Check nonce
</span><span class="cx" style="display: block; padding: 0 10px"> check_admin_referer( 'bp_activity_akismet_spam_' . $activity->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">- // Call an action before the spamming so plugins can modify things if they want to
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires before the marking activity as spam so plugins can modify things if they want to.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param int $activty_id Activity ID to be marked as spam.
+ * @param object $activity Activity object for the ID to be marked as spam.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_activity_before_action_spam_activity', $activity->id, $activity );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Mark as spam
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,6 +247,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Tell the user the spamming has been succesful
</span><span class="cx" style="display: block; padding: 0 10px"> bp_core_add_message( __( 'The activity item has been marked as spam and is no longer visible.', 'buddypress' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires after the marking activity as spam so plugins can act afterwards based on the activity.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param int $activty_id Activity ID that was marked as spam.
+ * @param int $user_id User ID associated with activity.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_activity_action_spam_activity', $activity_id, $activity->user_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check for the redirect query arg, otherwise let WP handle things
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -253,14 +295,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Check the nonce
</span><span class="cx" style="display: block; padding: 0 10px"> check_admin_referer( 'post_update', '_wpnonce_post_update' );
</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 activity info
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the content provided in the activity input field.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $whats-new Activity message being posted.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = apply_filters( 'bp_activity_post_update_content', $_POST['whats-new'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $_POST['whats-new-post-object'] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the item type that the activity update should be associated with.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $whats-new-post-object Item type to associate with.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $object = apply_filters( 'bp_activity_post_update_object', $_POST['whats-new-post-object'] );
</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 ( ! empty( $_POST['whats-new-post-in'] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters what component the activity is being to.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $whats-new-post-in Chosen component to post activity to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $item_id = apply_filters( 'bp_activity_post_update_item_id', $_POST['whats-new-post-in'] );
</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">@@ -280,8 +344,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_id = groups_post_update( array( 'content' => $content, 'group_id' => $item_id ) );
</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">- // Special circumstance so let filters handle it
</del><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters activity object for BuddyPress core and plugin authors before posting activity update.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $object Activity item being associated to.
+ * @param string $item_id Component ID being posted to.
+ * @param string $content Activity content being posted.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $activity_id = apply_filters( 'bp_activity_custom_update', $object, $item_id, $content );
</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">@@ -322,7 +395,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Check the nonce
</span><span class="cx" style="display: block; padding: 0 10px"> check_admin_referer( 'new_activity_comment', '_wpnonce_new_activity_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">+ /**
+ * Filters the activity ID a comment will be in reply to.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $comment_form_id ID of the activity being replied to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $activity_id = apply_filters( 'bp_activity_post_comment_activity_id', $_POST['comment_form_id'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the comment content for a comment reply.
+ *
+ * @since BuddyPress (1.2.0)
+ *
+ * @param string $ac_input_activity_id Comment content being posted.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = apply_filters( 'bp_activity_post_comment_content', $_POST['ac_input_' . $activity_id] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $content ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -640,7 +728,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! bp_get_option( 'wordpress_api_key' ) && ! defined( 'WPCOM_API_KEY' ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Bail if BuddyPress Activity Akismet support has been disabled by another plugin
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters if BuddyPress Activity Akismet support has been disabled by another plugin.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @param bool bp_is_akismet_active Return value of bp_is_akismet_active boolean function.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! apply_filters( 'bp_activity_use_akismet', bp_is_akismet_active() ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>