Changeset 10373 for trunk/src/bp-groups/bp-groups-forums.php

Timestamp:

11/22/2015 04:58:34 AM (9 years ago)

Author:

tw2113

Message:

More docs cleanup for BP-Groups component.

See #6401.

File:

• trunk/src/bp-groups/bp-groups-forums.php (modified) (15 diffs)

trunk/src/bp-groups/bp-groups-forums.php

@@ -66 +66 @@
  *
  * @param int $group_id Group id, passed from groups_details_updated.
- *
  * @return mixed
  */
@@ -112 +111 @@
  * @param mixed  $page      The page number where the new forum post should reside.
  *                          Default: false.
- *
  * @return mixed The new forum post ID on success. Boolean false on failure.
  */
@@ -221 +219 @@
  * @param string $topic_tags  A comma-delimited string of topic tags.
  * @param int    $forum_id    The forum ID this forum topic resides in.
- *
  * @return mixed The new topic object on success. Boolean false on failure.
  */
@@ -342 +339 @@
  * @param string $topic_text  The text for the forum topic.
  * @param mixed  $topic_tags  A comma-delimited string of topic tags. Optional.
- *
  * @return mixed The topic object on success. Boolean false on failure.
  */
@@ -364 +360 @@
     }
 
-    // Get the corresponding activity item
+    // Get the corresponding activity item.
     if ( bp_is_active( 'activity' ) ) {
         $id = bp_activity_get_activity_id( array(
@@ -421 +417 @@
  * @param int    $topic_id  The topic ID of the existing forum topic.
  * @param mixed  $page      The page number where the new forum post should reside. Optional.
- *
  * @return mixed The forum post ID on success. Boolean false on failure.
  */
@@ -454 +449 @@
     }
 
-    // Get the corresponding activity item
+    // Get the corresponding activity item.
     if ( bp_is_active( 'activity' ) ) {
         $id = bp_activity_get_activity_id( array(
@@ -507 +502 @@
  *
  * @param int $topic_id The ID of the topic to be deleted.
- *
  * @return bool True if the delete routine went through properly.
  */
@@ -513 +507 @@
     $bp = buddypress();
 
-    // Before deleting the thread, get the post ids so that their activity items can be deleted
+    // Before deleting the thread, get the post ids so that their activity items can be deleted.
     $posts  = bp_forums_get_topic_posts( array( 'topic_id' => $topic_id, 'per_page' => -1 ) );
     $action = bp_forums_delete_topic( array( 'topic_id' => $topic_id ) );
@@ -528 +522 @@
         do_action( 'groups_before_delete_group_forum_topic', $topic_id );
 
-        // Delete the corresponding activity stream items
+        // Delete the corresponding activity stream items.
         if ( bp_is_active( 'activity' ) ) {
 
-            // The activity item for the initial topic
+            // The activity item for the initial topic.
             bp_activity_delete( array(
                 'item_id'           => bp_get_current_group_id(),
@@ -539 +533 @@
             ) );
 
-            // The activity item for each post
+            // The activity item for each post.
             foreach ( (array) $posts as $post ) {
                 bp_activity_delete( array(
@@ -574 +568 @@
  *                           value isn't used in the function but is passed along
  *                           to do_action() hooks.
- *
  * @return bool True on success.
  */
@@ -593 +586 @@
         do_action( 'groups_before_delete_group_forum_post', $post_id, $topic_id );
 
-        // Delete the corresponding activity stream item
+        // Delete the corresponding activity stream item.
         if ( bp_is_active( 'activity' ) ) {
             bp_activity_delete( array(
@@ -624 +617 @@
  * @param string $type Either 'newest', 'popular', 'unreplied', 'tags'.
  *                     Default: 'newest'.
- *
  * @return int The topic count.
  */
@@ -647 +639 @@
  *                                  'all'. Default: 'public'.
  * @param string|bool $search_terms Optional. Limit by a search term.
- *
  * @return int The topic count.
  */