<!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][7390] trunk/bp-activity/bp-activity-actions.php: Inline doc improvements 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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7390">7390</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-06 15:05:32 +0000 (Sun, 06 Oct 2013)</dd>
</dl>

<h3>Log Message</h3>
<pre>Inline doc improvements for bp-activity-actions.php

See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a></pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityactionsphp">trunk/bp-activity/bp-activity-actions.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityactionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-actions.php (7389 => 7390)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-actions.php        2013-10-03 20:18:46 UTC (rev 7389)
+++ trunk/bp-activity/bp-activity-actions.php   2013-10-06 15:05:32 UTC (rev 7390)
</span><span class="lines">@@ -13,7 +13,7 @@
</span><span class="cx"> if ( !defined( 'ABSPATH' ) ) exit;
</span><span class="cx"> 
</span><span class="cx"> /**
</span><del>- * Allow core components and dependent plugins to register activity actions
</del><ins>+ * Allow core components and dependent plugins to register activity actions.
</ins><span class="cx">  *
</span><span class="cx">  * @since BuddyPress (1.2)
</span><span class="cx">  *
</span><span class="lines">@@ -25,7 +25,7 @@
</span><span class="cx"> add_action( 'bp_init', 'bp_register_activity_actions', 8 );
</span><span class="cx"> 
</span><span class="cx"> /**
</span><del>- * Allow core components and dependent plugins to register activity actions
</del><ins>+ * Catch and route requests for single activity item permalinks.
</ins><span class="cx">  *
</span><span class="cx">  * @since BuddyPress (1.2)
</span><span class="cx">  *
</span><span class="lines">@@ -38,11 +38,11 @@
</span><span class="cx">  * @uses bp_core_get_user_domain()
</span><span class="cx">  * @uses groups_get_group()
</span><span class="cx">  * @uses bp_get_group_permalink()
</span><del>- * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_redirect_url' hook
</del><ins>+ * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_redirect_url' hook.
</ins><span class="cx">  * @uses bp_core_redirect()
</span><span class="cx">  * @uses bp_get_root_domain()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_permalink_router() {
</span><span class="cx"> 
</span><span class="lines">@@ -124,7 +124,7 @@
</span><span class="cx">  * @uses do_action() Calls 'bp_activity_action_delete_activity' hook to allow actions to be taken after the activity is deleted.
</span><span class="cx">  * @uses bp_core_redirect()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_delete_activity( $activity_id = 0 ) {
</span><span class="cx"> 
</span><span class="lines">@@ -169,12 +169,13 @@
</span><span class="cx"> add_action( 'bp_actions', 'bp_activity_action_delete_activity' );
</span><span class="cx"> 
</span><span class="cx"> /**
</span><del>- * Mark specific activity item as spam and redirect to previous page
</del><ins>+ * Mark specific activity item as spam and redirect to previous page.
</ins><span class="cx">  *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx">  * @global object $bp BuddyPress global settings
</span><span class="cx">  * @param int $activity_id Activity id to be deleted. Defaults to 0.
</span><del>- * @return bool False on failure
- * @since BuddyPress (1.6)
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_spam_activity( $activity_id = 0 ) {
</span><span class="cx">  global $bp;
</span><span class="lines">@@ -241,7 +242,7 @@
</span><span class="cx">  * @uses bp_core_redirect()
</span><span class="cx">  * @uses apply_filters() To call 'bp_activity_custom_update' hook.
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_post_update() {
</span><span class="cx"> 
</span><span class="lines">@@ -305,7 +306,7 @@
</span><span class="cx">  * @uses bp_activity_new_comment()
</span><span class="cx">  * @uses wp_get_referer()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_post_comment() {
</span><span class="cx"> 
</span><span class="lines">@@ -353,7 +354,7 @@
</span><span class="cx">  * @uses bp_core_redirect()
</span><span class="cx">  * @uses wp_get_referer()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_mark_favorite() {
</span><span class="cx"> 
</span><span class="lines">@@ -387,7 +388,7 @@
</span><span class="cx">  * @uses bp_core_redirect()
</span><span class="cx">  * @uses wp_get_referer()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_remove_favorite() {
</span><span class="cx"> 
</span><span class="lines">@@ -407,18 +408,17 @@
</span><span class="cx"> add_action( 'bp_actions', 'bp_activity_action_remove_favorite' );
</span><span class="cx"> 
</span><span class="cx"> /**
</span><del>- * Load the sitewide feed.
</del><ins>+ * Load the sitewide activity feed.
</ins><span class="cx">  *
</span><span class="cx">  * @since BuddyPress (1.0)
</span><span class="cx">  *
</span><span class="cx">  * @global object $bp BuddyPress global settings
</span><del>- * @global object $wp_query
</del><span class="cx">  * @uses bp_is_activity_component()
</span><span class="cx">  * @uses bp_is_current_action()
</span><span class="cx">  * @uses bp_is_user()
</span><span class="cx">  * @uses status_header()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_sitewide_feed() {
</span><span class="cx">  global $bp;
</span><span class="lines">@@ -441,16 +441,15 @@
</span><span class="cx"> add_action( 'bp_actions', 'bp_activity_action_sitewide_feed' );
</span><span class="cx"> 
</span><span class="cx"> /**
</span><del>- * Load a user's personal feed.
</del><ins>+ * Load a user's personal activity feed.
</ins><span class="cx">  *
</span><span class="cx">  * @since BuddyPress (1.0)
</span><span class="cx">  *
</span><del>- * @global object $wp_query
</del><span class="cx">  * @uses bp_is_user_activity()
</span><span class="cx">  * @uses bp_is_current_action()
</span><span class="cx">  * @uses status_header()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_personal_feed() {
</span><span class="cx">  if ( ! bp_is_user_activity() || ! bp_is_current_action( 'feed' ) ) {
</span><span class="lines">@@ -472,11 +471,10 @@
</span><span class="cx"> add_action( 'bp_actions', 'bp_activity_action_personal_feed' );
</span><span class="cx"> 
</span><span class="cx"> /**
</span><del>- * Load a user's friends feed.
</del><ins>+ * Load a user's friends' activity feed.
</ins><span class="cx">  *
</span><span class="cx">  * @since BuddyPress (1.0)
</span><span class="cx">  *
</span><del>- * @global object $wp_query
</del><span class="cx">  * @uses bp_is_active()
</span><span class="cx">  * @uses bp_is_user_activity()
</span><span class="cx">  * @uses bp_is_current_action()
</span><span class="lines">@@ -484,7 +482,7 @@
</span><span class="cx">  * @uses bp_is_action_variable()
</span><span class="cx">  * @uses status_header()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_friends_feed() {
</span><span class="cx">  if ( ! bp_is_active( 'friends' ) || ! bp_is_user_activity() || ! bp_is_current_action( bp_get_friends_slug() ) || ! bp_is_action_variable( 'feed', 0 ) ) {
</span><span class="lines">@@ -506,11 +504,10 @@
</span><span class="cx"> add_action( 'bp_actions', 'bp_activity_action_friends_feed' );
</span><span class="cx"> 
</span><span class="cx"> /**
</span><del>- * Load a user's my groups feed.
</del><ins>+ * Load the activity feed for a user's groups.
</ins><span class="cx">  *
</span><span class="cx">  * @since BuddyPress (1.2)
</span><span class="cx">  *
</span><del>- * @global object $wp_query
</del><span class="cx">  * @uses bp_is_active()
</span><span class="cx">  * @uses bp_is_user_activity()
</span><span class="cx">  * @uses bp_is_current_action()
</span><span class="lines">@@ -518,7 +515,7 @@
</span><span class="cx">  * @uses bp_is_action_variable()
</span><span class="cx">  * @uses status_header()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_my_groups_feed() {
</span><span class="cx">  if ( ! bp_is_active( 'groups' ) || ! bp_is_user_activity() || ! bp_is_current_action( bp_get_groups_slug() ) || ! bp_is_action_variable( 'feed', 0 ) ) {
</span><span class="lines">@@ -552,13 +549,12 @@
</span><span class="cx">  *
</span><span class="cx">  * @since BuddyPress (1.2)
</span><span class="cx">  *
</span><del>- * @global object $wp_query
</del><span class="cx">  * @uses bp_is_user_activity()
</span><span class="cx">  * @uses bp_is_current_action()
</span><span class="cx">  * @uses bp_is_action_variable()
</span><span class="cx">  * @uses status_header()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_mentions_feed() {
</span><span class="cx">  if ( ! bp_activity_do_mentions() ) {
</span><span class="lines">@@ -590,13 +586,12 @@
</span><span class="cx">  *
</span><span class="cx">  * @since BuddyPress (1.2)
</span><span class="cx">  *
</span><del>- * @global object $wp_query
</del><span class="cx">  * @uses bp_is_user_activity()
</span><span class="cx">  * @uses bp_is_current_action()
</span><span class="cx">  * @uses bp_is_action_variable()
</span><span class="cx">  * @uses status_header()
</span><span class="cx">  *
</span><del>- * @return bool False on failure
</del><ins>+ * @return bool False on failure.
</ins><span class="cx">  */
</span><span class="cx"> function bp_activity_action_favorites_feed() {
</span><span class="cx">  if ( ! bp_is_user_activity() || ! bp_is_current_action( 'favorites' ) || ! bp_is_action_variable( 'feed', 0 ) ) {
</span><span class="lines">@@ -622,10 +617,11 @@
</span><span class="cx"> add_action( 'bp_actions', 'bp_activity_action_favorites_feed' );
</span><span class="cx"> 
</span><span class="cx"> /**
</span><del>- * Loads Akismet
</del><ins>+ * Loads Akismet filtering for activity.
</ins><span class="cx">  *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx">  * @global object $bp BuddyPress global settings
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx">  */
</span><span class="cx"> function bp_activity_setup_akismet() {
</span><span class="cx">  global $bp;
</span></span></pre>
</div>
</div>

</body>
</html>