<!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][8718] trunk/src/bp-activity/bp-activity-template.php: Correct phpdoc for `bp_activity_recurse_comment_count()` and `bp_activity_get_comment_count()`.</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/8718">8718</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2014-07-29 18:52:10 +0000 (Tue, 29 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Correct phpdoc for `bp_activity_recurse_comment_count()` and `bp_activity_get_comment_count()`. Also formally deprecate `$args` in `bp_activity_get_comment_count()` and add filter at the end of `bp_activity_recurse_comment_count()` so it can be manipulated by third party plugins.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivitytemplatephp">trunk/src/bp-activity/bp-activity-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivitytemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-activity/bp-activity-template.php (8717 => 8718)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-activity/bp-activity-template.php 2014-07-29 14:01:59 UTC (rev 8717)
+++ trunk/src/bp-activity/bp-activity-template.php 2014-07-29 18:52:10 UTC (rev 8718)
</span><span class="lines">@@ -2146,63 +2146,65 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Return the content of the activity comment currently being displayed.
</del><ins>+ * Return the comment count of an activity item.
</ins><span class="cx"> *
</span><del>- * The content is run through two filters. 'bp_get_activity_content'
- * will apply all filters applied to activity items in general. Use
- * 'bp_activity_comment_content' to modify the content of activity
- * comments only.
- *
</del><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><span class="cx"> * @global object $activities_template {@link BP_Activity_Template}
</span><span class="cx"> * @uses bp_activity_recurse_comment_count()
</span><span class="cx"> * @uses apply_filters() To call the 'bp_activity_get_comment_count' hook.
</span><del>- * @todo deprecate $args
</del><span class="cx"> *
</span><del>- * @param array $args Deprecated.
</del><ins>+ * @param array $deprecated Deprecated.
+ *
</ins><span class="cx"> * @return int $count The activity comment count.
</span><span class="cx"> */
</span><del>- function bp_activity_get_comment_count( $args = '' ) {
</del><ins>+ function bp_activity_get_comment_count( $deprecated = null ) {
</ins><span class="cx"> global $activities_template;
</span><span class="cx">
</span><del>- if ( !isset( $activities_template->activity->children ) || !$activities_template->activity->children )
- return 0;
</del><ins>+ // Deprecated notice about $args
+ if ( ! empty( $deprecated ) ) {
+ _deprecated_argument( __FUNCTION__, '1.2', sprintf( __( '%1$s no longer accepts arguments. See the inline documentation at %2$s for more details.', 'buddypress' ), __FUNCTION__, __FILE__ ) );
+ }
</ins><span class="cx">
</span><del>- $count = bp_activity_recurse_comment_count( $activities_template->activity );
</del><ins>+ // Get the count using the purpose-built recursive function
+ $count = ! empty( $activities_template->activity->children )
+ ? bp_activity_recurse_comment_count( $activities_template->activity )
+ : 0;
</ins><span class="cx">
</span><span class="cx"> return apply_filters( 'bp_activity_get_comment_count', (int) $count );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Return the content of the activity comment currently being displayed.
</del><ins>+ * Return the total number of comments to the current comment.
</ins><span class="cx"> *
</span><del>- * The content is run through two filters. 'bp_get_activity_content'
- * will apply all filters applied to activity items in general.
- * Use bp_activity_comment_content to modify the content of
- * activity comments only.
</del><ins>+ * This function recursively adds the total number of comments each
+ * activity child has, and returns them.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.2)
</span><span class="cx"> *
</span><span class="cx"> * @uses bp_activity_recurse_comment_count()
</span><del>- * @uses apply_filters() To call the 'bp_activity_get_comment_count' hook
- * @todo investigate why bp_activity_recurse_comment_count() is used while being declared
</del><ins>+ * @uses apply_filters() To call the 'bp_activity_recurse_comment_count' hook
</ins><span class="cx"> *
</span><span class="cx"> * @param object $comment Activity comment object.
</span><span class="cx"> * @param int $count The current iteration count.
</span><ins>+ *
</ins><span class="cx"> * @return int $count The activity comment count.
</span><span class="cx"> */
</span><span class="cx"> function bp_activity_recurse_comment_count( $comment, $count = 0 ) {
</span><span class="cx">
</span><del>- if ( empty( $comment->children ) )
- return $count;
</del><ins>+ // Copy the count
+ $new_count = $count;
</ins><span class="cx">
</span><del>- foreach ( (array) $comment->children as $comment ) {
- $count++;
- $count = bp_activity_recurse_comment_count( $comment, $count );
</del><ins>+ // Loop through children and recursively count comments
+ if ( ! empty( $comment->children ) ) {
+ foreach ( (array) $comment->children as $comment ) {
+ $new_count++;
+ $new_count = bp_activity_recurse_comment_count( $comment, $new_count );
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- return $count;
</del><ins>+ // Filter and return
+ return apply_filters( 'bp_activity_recurse_comment_count', $new_count, $comment, $count );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre>
</div>
</div>
</body>
</html>