Changeset 6746

Timestamp:

11/29/2017 01:11:59 AM (8 years ago)

Author:

johnjamesjacoby

Message:

Update engagements documentation.

Fixes #3176. Props espellcaste.

File:

• trunk/src/includes/users/engagements.php (modified) (3 diffs)

trunk/src/includes/users/engagements.php

@@ -452 +452 @@
  * @since 2.6.0 bbPress (r6618) Signature changed to accept an array of arguments
  *
- * @param array $args Optional. Arguments to pass into bbp_has_replies()
+ * @param array $args Optional. Arguments to pass into bbp_has_topics()
  *
  * @return bool True if user has favorites, otherwise false
@@ -494 +494 @@
  * @param int $topic_id Optional. Topic id
  *
- * @return bool Always true
+ * @return bool True if the topic was added to user's favorites, otherwise false
  */
 function bbp_add_user_favorite( $user_id = 0, $topic_id = 0 ) {
@@ -528 +528 @@
  * @param int $topic_id Optional. Topic id
  *
- * @return bool True if the topic was removed from user's favorites, or false
+ * @return bool True if the topic was removed from user's favorites, otherwise false
  */
 function bbp_remove_user_favorite( $user_id, $topic_id ) {