Changeset 10821 for trunk/src/bp-forums/bp-forums-functions.php

Timestamp:

05/29/2016 07:08:27 AM (9 years ago)

Author:

tw2113

Message:

Plenty of @since tags for the BP Forums component.

See #6399.

File:

• trunk/src/bp-forums/bp-forums-functions.php (modified) (22 diffs)

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

@@ -77 +77 @@
  * Wrapper for {@link bb_get_forum()}.
  *
+ * @since 1.0.0
+ *
  * @param int $forum_id ID of the forum being fetched.
  * @return object bbPress forum object.
@@ -91 +93 @@
  *
  * Wrapper for {@link bb_new_forum()}.
+ *
+ * @since 1.0.0
  *
  * @param array|string $args {
@@ -124 +128 @@
  *
  * Wrapper for {@link bb_update_forum(}.
+ *
+ * @since 1.2.5
  *
  * @param array|string $args {
@@ -159 +165 @@
  * Delete a group forum by the group id.
  *
+ * @since 1.6.0
+ *
  * @param int $group_id ID of the group whose forum is to be deleted.
  */
@@ -177 +185 @@
 /**
  * Fetch a set of forum topics.
+ *
+ * @since 1.1.0
  *
  * @param array|string $args {
@@ -256 +266 @@
  * Get additional details about a given forum topic.
  *
+ * @since 1.0.0
+ *
  * @param int $topic_id ID of the topic for which you're fetching details.
  * @return object Details about the topic.
@@ -274 +286 @@
  * Wrapper for {@link bb_get_id_from_slug()}.
  *
+ * @since 1.1.0
+ *
  * @param string $topic_slug Slug of the topic.
  * @return int|bool ID of the topic (if found), false on failure.
@@ -290 +304 @@
 /**
  * Create a new forum topic.
+ *
+ * @since 1.0.0
  *
  * @param array|string $args {
@@ -374 +390 @@
  * Update a topic's details.
  *
+ * @since 1.1.0
+ *
  * @param array|string $args {
  *     Array of arguments.
@@ -419 +437 @@
 }
 
+/**
+ * Set a topic as sticky/unsticky.
+ *
+ * @since 1.1.0
+ *
+ * @param string $args Array of arguments for sticky topic.
+ * @return bool
+ */
 function bp_forums_sticky_topic( $args = '' ) {
 
@@ -440 +466 @@
 /**
  * Set a topic's open/closed status.
+ *
+ * @since 1.1.0
  *
  * @param array|string $args {
@@ -470 +498 @@
  * Delete a topic.
  *
+ * @since 1.1.0
+ *
  * @param array|string $args {
  *     @type int $topic_id ID of the topic being deleted.
@@ -490 +520 @@
 /**
  * Get a count of the total topics on the site.
+ *
+ * @since 1.2.0
  *
  * @return int $count Total topic count.
@@ -593 +625 @@
  * Get a total "Topics Started" count for a given user.
  *
+ * @since 1.2.0
+ *
  * @param int    $user_id ID of the user being queried. Falls back on displayed
  *                        user, then loggedin.
@@ -694 +728 @@
  * - information about topic users that may have been deleted/spammed
  *
+ * @since 1.2.0
+ *
  * @param array $topics Array of topics.
  * @return array $topics Topics with BP details added.
@@ -757 +793 @@
  * Get the posts belonging to a topic.
  *
+ * @since 1.1.0
+ *
  * @param array|string $args {
  *     @type int    $topic_id ID of the topic for which posts are being fetched.
@@ -789 +827 @@
  * Wrapper for {@link bb_get_post()}.
  *
+ * @since 1.0.0
+ *
  * @param int $post_id ID of the post being fetched.
  * @return object Post object.
@@ -803 +843 @@
  *
  * Wrapper for {@link bb_delete_post()}.
+ *
+ * @since 1.1.0
  *
  * @param array|string $args {
@@ -825 +867 @@
 /**
  * Create a new post.
+ *
+ * @since 1.1.0
  *
  * @param array|string $args {
@@ -906 +950 @@
  * - BP fullname for each poster
  *
+ * @since 1.2.0
+ *
  * @param array $posts List of posts.
  * @return array Posts with BP-data added.
@@ -959 +1005 @@
  * Get topic and post counts for a given forum.
  *
+ * @since 1.1.0
+ *
  * @param int $forum_id ID of the forum.
  * @return object Object with properties $topics (topic count) and $posts
@@ -975 +1023 @@
 /**
  * Map WordPress caps onto bbPress users, to ensure that they can post.
+ *
+ * @since 1.1.0
  *
  * @param array $allcaps Array of capabilities.