Changeset 6111

Timestamp:

11/02/2016 05:45:34 AM (4 years ago)

Author:

netweb

Message:

Users: Update PHPDoc's for user functions and capabilities.

See #2959.

Location:

trunk/src/includes/users

Files:

• capabilities.php (modified) (5 diffs)
• functions.php (modified) (4 diffs)

trunk/src/includes/users/capabilities.php

@@ -475 +475 @@
  * @uses restore_current_blog()
  *
- * @return If no user ID passed
+ * @return bool If no user ID passed.
  */
 function bbp_make_spam_user( $user_id = 0 ) {
@@ -566 +566 @@
  * @uses restore_current_blog()
  *
- * @return If no user ID passed
+ * @return bool If no user ID passed.
  */
 function bbp_make_ham_user( $user_id = 0 ) {
@@ -765 +765 @@
  *
  * @param int $user_id User ID to check
- * @param int $blog_id Blog ID to check
  *
  * @uses bbp_get_user_id() To verify the user ID
@@ -773 +772 @@
  * @uses apply_filters() To allow override of this functions result
  *
- * @return boolean Whether or not the user has a profile on this blog_id
+ * @return bool Whether or not the user has a profile on this blog_id.
  */
 function bbp_user_has_profile( $user_id = 0 ) {
@@ -823 +822 @@
  * @param int $user_id
  *
- * @return mixed
+ * @return bool
  */
 function bbp_remove_moderator( $object_id = 0, $user_id = 0 ) {

trunk/src/includes/users/functions.php

@@ -175 +175 @@
  * Set a user id on an object
  *
- * @since 2.7 bbPress()
+ * @since 2.6.0 bbPress(r6109)
  *
  * @param int    $object_id The object id
@@ -198 +198 @@
  * Remove a user id from an object
  *
- * @since 2.7 bbPress()
+ * @since 2.6.0 bbPress(r6109)
  *
  * @param int    $object_id The post id
@@ -221 +221 @@
  * Get user taxonomy terms for an object
  *
- * @since 2.7 bbPress()
+ * @since 2.6.0 bbPress(r6109)
  *
  * @param int    $object_id The object id
@@ -242 +242 @@
  * Check if the user id is set on an object
  *
- * @since 2.7 bbPress()
+ * @since 2.6.0 bbPress(r6109)
  *
  * @param int    $object_id The object id