<!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][7391] trunk/bp-activity/bp-activity-admin.php: Inline doc improvements for bp-activity-admin.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/7391">7391</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-06 15:40:14 +0000 (Sun, 06 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline doc improvements for bp-activity-admin.php
See <a href="http://buddypress.trac.wordpress.org/ticket/5022">#5022</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityadminphp">trunk/bp-activity/bp-activity-admin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityadminphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-admin.php (7390 => 7391)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-admin.php 2013-10-06 15:05:32 UTC (rev 7390)
+++ trunk/bp-activity/bp-activity-admin.php 2013-10-06 15:40:14 UTC (rev 7391)
</span><span class="lines">@@ -21,7 +21,7 @@
</span><span class="cx"> add_filter( 'set-screen-option', 'bp_activity_admin_screen_options', 10, 3 );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Registers the Activity component admin screen
</del><ins>+ * Registers the Activity component admin screen.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> */
</span><span class="lines">@@ -43,12 +43,16 @@
</span><span class="cx"> add_action( bp_core_admin_hook(), 'bp_activity_add_admin_menu' );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Add activity component to custom menus array
</del><ins>+ * Add activity component to custom menus array.
</ins><span class="cx"> *
</span><ins>+ * Several BuddyPress components have top-level menu items in the Dashboard,
+ * which all appear together in the middle of the Dashboard menu. This function
+ * adds the Activity page to the array of these menu items.
+ *
</ins><span class="cx"> * @since BuddyPress (1.7)
</span><span class="cx"> *
</span><del>- * @param array $custom_menus
- * @return array
</del><ins>+ * @param array $custom_menus The list of top-level BP menu items.
+ * @return array $custom_menus List of top-level BP menu items, with Activity added
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_menu_order( $custom_menus = array() ) {
</span><span class="cx"> array_push( $custom_menus, 'bp-activity' );
</span><span class="lines">@@ -57,9 +61,11 @@
</span><span class="cx"> add_filter( 'bp_admin_menu_order', 'bp_activity_admin_menu_order' );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * AJAX receiver for Activity replies via the admin screen. Adds a new activity
- * comment, and returns HTML for a new table row.
</del><ins>+ * AJAX receiver for Activity replies via the admin screen.
</ins><span class="cx"> *
</span><ins>+ * Processes requests to add new activity comments, and echoes HTML for a new
+ * table row.
+ *
</ins><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_reply() {
</span><span class="lines">@@ -128,13 +134,14 @@
</span><span class="cx"> add_action( 'wp_ajax_bp-activity-admin-reply', 'bp_activity_admin_reply' );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Handle save/update of screen options for the Activity component admin screen
</del><ins>+ * Handle save/update of screen options for the Activity component admin screen.
</ins><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @param string $value Will always be false unless another plugin filters it first.
</span><del>- * @param string $option Screen option name
- * @param string $new_value Screen option form value
</del><ins>+ * @param string $option Screen option name.
+ * @param string $new_value Screen option form value.
</ins><span class="cx"> * @return string Option value. False to abandon update.
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_screen_options( $value, $option, $new_value ) {
</span><span class="cx"> if ( 'toplevel_page_bp_activity_per_page' != $option && 'toplevel_page_bp_activity_network_per_page' != $option )
</span><span class="lines">@@ -149,11 +156,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Hide the advanced edit meta boxes by default, so we don't clutter the scren.
</del><ins>+ * Hide the advanced edit meta boxes by default, so we don't clutter the screen.
</ins><span class="cx"> *
</span><del>- * @param WP_Screen $screen Screen identifier
- * @return array Hidden Meta Boxes
- * @since BuddyPress (1.0)
</del><ins>+ * @since BuddyPress (1.6)
+ *
+ * @param WP_Screen $screen Screen identifier.
+ * @return array Hidden Meta Boxes.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_edit_hidden_metaboxes( $hidden, $screen ) {
</span><span class="cx"> if ( empty( $screen->id ) || 'toplevel_page_bp-activity' != $screen->id && 'toplevel_page_bp-activity_network' != $screen->id )
</span><span class="lines">@@ -167,11 +175,17 @@
</span><span class="cx"> add_filter( 'default_hidden_meta_boxes', 'bp_activity_admin_edit_hidden_metaboxes', 10, 2 );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Set up the admin page before any output is sent. Register contextual help and screen options for this admin page.
</del><ins>+ * Set up the Activity admin page.
</ins><span class="cx"> *
</span><del>- * @global object $bp BuddyPress global settings
- * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table
</del><ins>+ * Does the following:
+ * - Register contextual help and screen options for this admin page.
+ * - Enqueues scripts and styles
+ * - Catches POST and GET requests related to Activity
+ *
</ins><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @global object $bp BuddyPress global settings.
+ * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_load() {
</span><span class="cx"> global $bp, $bp_activity_list_table;
</span><span class="lines">@@ -518,7 +532,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Outputs the Activity component admin screens
</del><ins>+ * Outputs the Activity component admin screens.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> */
</span><span class="lines">@@ -536,9 +550,8 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Display the single activity edit screen
</del><ins>+ * Display the single activity edit screen.
</ins><span class="cx"> *
</span><del>- * @global int $screen_layout_columns Number of columns shown on this admin page
</del><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_edit() {
</span><span class="lines">@@ -628,10 +641,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Status metabox for the Activity admin edit screen
</del><ins>+ * Status metabox for the Activity admin edit screen.
</ins><span class="cx"> *
</span><del>- * @param object $item Activity item
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param object $item Activity item.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_edit_metabox_status( $item ) {
</span><span class="cx"> ?>
</span><span class="lines">@@ -683,10 +697,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Primary link metabox for the Activity admin edit screen
</del><ins>+ * Primary link metabox for the Activity admin edit screen.
</ins><span class="cx"> *
</span><del>- * @param object $item Activity item
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param object $item Activity item.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_edit_metabox_link( $item ) {
</span><span class="cx"> ?>
</span><span class="lines">@@ -699,10 +714,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * User ID metabox for the Activity admin edit screen
</del><ins>+ * User ID metabox for the Activity admin edit screen.
</ins><span class="cx"> *
</span><del>- * @param object $item Activity item
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param object $item Activity item.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_edit_metabox_userid( $item ) {
</span><span class="cx"> ?>
</span><span class="lines">@@ -716,9 +732,11 @@
</span><span class="cx"> /**
</span><span class="cx"> * Activity type metabox for the Activity admin edit screen
</span><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @global object $bp BuddyPress global settings
</span><ins>+ *
</ins><span class="cx"> * @param object $item Activity item
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_edit_metabox_type( $item ) {
</span><span class="cx"> global $bp;
</span><span class="lines">@@ -750,10 +768,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Primary item ID/Secondary item ID metabox for the Activity admin edit screen
</del><ins>+ * Primary item ID/Secondary item ID metabox for the Activity admin edit screen.
</ins><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @param object $item Activity item
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_edit_metabox_itemids( $item ) {
</span><span class="cx"> ?>
</span><span class="lines">@@ -773,9 +792,10 @@
</span><span class="cx"> /**
</span><span class="cx"> * Display the Activity admin index screen, which contains a list of all the activities.
</span><span class="cx"> *
</span><del>- * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table
- * @global string $plugin_page
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table.
+ * @global string $plugin_page The current plugin page.
</ins><span class="cx"> */
</span><span class="cx"> function bp_activity_admin_index() {
</span><span class="cx"> global $bp_activity_list_table, $plugin_page;
</span><span class="lines">@@ -926,7 +946,7 @@
</span><span class="cx"> protected $activity_user_id = array();
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Constructor
</del><ins>+ * Constructor.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> */
</span><span class="lines">@@ -1042,10 +1062,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get an array of all the columns on the page
</del><ins>+ * Get an array of all the columns on the page.
</ins><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @return array
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> */
</span><span class="cx"> function get_column_info() {
</span><span class="cx"> $this->_column_headers = array(
</span><span class="lines">@@ -1058,7 +1079,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Displays a message on screen when no items are found (e.g. no search matches)
</del><ins>+ * Displays a message on screen when no items are found (e.g. no search matches).
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> */
</span><span class="lines">@@ -1067,7 +1088,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Outputs the Activity data table
</del><ins>+ * Outputs the Activity data table.
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> */
</span><span class="lines">@@ -1099,10 +1120,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Generates content for a single row of the table
</del><ins>+ * Generates content for a single row of the table.
</ins><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @param object $item The current item
</span><del>- * @since BuddyPress (1.6)
</del><span class="cx"> */
</span><span class="cx"> function single_row( $item ) {
</span><span class="cx"> static $even = false;
</span><span class="lines">@@ -1137,11 +1159,12 @@
</span><span class="cx"> <?php
</span><span class="cx"> }
</span><span class="cx">
</span><del>- /**
- * Get bulk actions
</del><ins>+ /**
+ * Get bulk actions.
</ins><span class="cx"> *
</span><del>- * @return array Key/value pairs for the bulk actions dropdown
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @return array Key/value pairs for the bulk actions dropdown.
</ins><span class="cx"> */
</span><span class="cx"> function get_bulk_actions() {
</span><span class="cx"> $actions = array();
</span><span class="lines">@@ -1155,9 +1178,11 @@
</span><span class="cx"> /**
</span><span class="cx"> * Get the table column titles.
</span><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @see WP_List_Table::single_row_columns()
</span><del>- * @return array
- * @since BuddyPress (1.6)
</del><ins>+ *
+ * @return array The columns to appear in the Activity list table.
</ins><span class="cx"> */
</span><span class="cx"> function get_columns() {
</span><span class="cx"> return array(
</span><span class="lines">@@ -1169,11 +1194,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the column names for sortable columns
</del><ins>+ * Get the column names for sortable columns.
</ins><span class="cx"> *
</span><del>- * @return array
</del><ins>+ * Currently, returns an empty array (no columns are sortable).
+ *
</ins><span class="cx"> * @since BuddyPress (1.6)
</span><span class="cx"> * @todo For this to work, BP_Activity_Activity::get() needs updating to supporting ordering by specific fields
</span><ins>+ *
+ * @return array The columns that can be sorted on the Activity screen.
</ins><span class="cx"> */
</span><span class="cx"> function get_sortable_columns() {
</span><span class="cx"> return array();
</span><span class="lines">@@ -1184,10 +1212,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Markup for the "filter" part of the form (i.e. which activity type to display)
</del><ins>+ * Markup for the "filter" part of the form (i.e. which activity type to display).
</ins><span class="cx"> *
</span><del>- * @param string $which 'top' or 'bottom'
</del><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param string $which 'top' or 'bottom'.
</ins><span class="cx"> */
</span><span class="cx"> function extra_tablenav( $which ) {
</span><span class="cx"> if ( 'bottom' == $which )
</span><span class="lines">@@ -1216,22 +1245,26 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Checkbox column
</del><ins>+ * Checkbox column markup.
</ins><span class="cx"> *
</span><del>- * @param array $item A singular item (one full row)
</del><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @see WP_List_Table::single_row_columns()
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ *
+ * @param array $item A singular item (one full row).
</ins><span class="cx"> */
</span><span class="cx"> function column_cb( $item ) {
</span><span class="cx"> printf( '<label class="screen-reader-text" for="aid-%1$d">' . __( 'Select activity item %1$d', 'buddypress' ) . '</label><input type="checkbox" name="aid[]" value="%1$d" id="aid-%1$d" />', $item['id'] );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Author column
</del><ins>+ * Author column markup.
</ins><span class="cx"> *
</span><ins>+ * @since BuddyPress (1.6)
+ *
+ * @see WP_List_Table::single_row_columns()
+ *
</ins><span class="cx"> * @param array $item A singular item (one full row)
</span><del>- * @see WP_List_Table::single_row_columns()
- * @since BuddyPress (1.6)
</del><span class="cx"> */
</span><span class="cx"> function column_author( $item ) {
</span><span class="cx"> echo '<strong>' . get_avatar( $item['user_id'], '32' ) . ' ' . bp_core_get_userlink( $item['user_id'] ) . '</strong>';
</span><span class="lines">@@ -1242,9 +1275,11 @@
</span><span class="cx"> *
</span><span class="cx"> * Called "comment" in the CSS so we can re-use some WP core CSS.
</span><span class="cx"> *
</span><del>- * @param array $item A singular item (one full row)
</del><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @see WP_List_Table::single_row_columns()
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ &
+ * @param array $item A singular item (one full row).
</ins><span class="cx"> */
</span><span class="cx"> function column_comment( $item ) {
</span><span class="cx"> // Determine what type of item (row) we're dealing with
</span><span class="lines">@@ -1312,11 +1347,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * "In response to" column
</del><ins>+ * "In response to" column markup.
</ins><span class="cx"> *
</span><del>- * @param array $item A singular item (one full row)
</del><ins>+ * @since BuddyPress (1.6)
+ *
</ins><span class="cx"> * @see WP_List_Table::single_row_columns()
</span><del>- * @since BuddyPress (1.6)
</del><ins>+ *
+ * @param array $item A singular item (one full row).
</ins><span class="cx"> */
</span><span class="cx"> function column_response( $item ) {
</span><span class="cx"> // Is $item is a root activity?
</span><span class="lines">@@ -1341,10 +1378,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * A wrapper function for the BP_Activity_List_Table to get the specified activity's user ID.
</del><ins>+ * Get the user id associated with a given activity item.
</ins><span class="cx"> *
</span><del>- * @param int $activity_id Activity ID to retrieve User ID for
</del><ins>+ * Wraps bp_activity_get_specific(), with some additional logic for
+ * avoiding duplicate queries.
+ *
</ins><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param int $activity_id Activity ID to retrieve User ID for.
+ * @return int User ID of the activity item in question.
</ins><span class="cx"> */
</span><span class="cx"> protected function get_activity_user_id( $activity_id ) {
</span><span class="cx"> // If there is an existing activity/user ID mapping, just return the user ID.
</span><span class="lines">@@ -1374,11 +1416,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Helper function to flatten all activites returned from bp_activity_get() into a single array.
</del><ins>+ * Flatten the activity array.
</ins><span class="cx"> *
</span><del>- * @param array $tree Source array
- * @return array Flattened array
</del><ins>+ * In some cases, BuddyPress gives us a structured tree of activity
+ * items plus their comments. This method converts it to a flat array.
+ *
</ins><span class="cx"> * @since BuddyPress (1.6)
</span><ins>+ *
+ * @param array $tree Source array.
+ * @return array Flattened array.
</ins><span class="cx"> */
</span><span class="cx"> public static function flatten_activity_array( $tree ){
</span><span class="cx"> foreach ( (array) $tree as $node ) {
</span></span></pre>
</div>
</div>
</body>
</html>