Changeset 6519

Timestamp:

06/10/2017 08:42:23 PM (8 years ago)

Author:

johnjamesjacoby

Message:

Moderators: Add an $object_type parameter to add/remove/delete functions.

In a future release, this will more easily allow objects like taxonomy-terms to have their own moderators, and is also necessary for future enhancements to the WordPress.org support forums where custom taxonomies are used for prevalently than in bbPress core currently.

See #3068, #459.

File:

• trunk/src/includes/users/capabilities.php (modified) (5 diffs)

trunk/src/includes/users/capabilities.php

@@ -798 +798 @@
  * Add a moderator to an object
  *
- * @since 2.6.0 bbPRess
- *
- * @param int $object_id Traditionally a forum ID, but could be useful
- * @param int $user_id
- *
- * @return @mixed
- */
-function bbp_add_moderator( $object_id = 0, $user_id = 0 ) {
-    return bbp_add_user_to_object( $object_id, $user_id, '_bbp_moderator_id' );
+ * @since 2.6.0 bbPress (r6056)
+ *
+ * @param int    $object_id   Traditionally a post ID
+ * @param int    $user_id     User ID
+ * @param string $object_type Type of meta (post,term,user,comment)
+ *
+ * @return bool
+ */
+function bbp_add_moderator( $object_id = 0, $user_id = 0, $object_type = 'post' ) {
+    return bbp_add_user_to_object( $object_id, $user_id, '_bbp_moderator_id', $object_type );
 }
 
@@ -812 +813 @@
  * Remove a moderator user ID from an object
  *
- * @since 2.6.0 bbPress
- *
- * @param int $object_id
- * @param int $user_id
+ * @since 2.6.0 bbPress (r6056)
+ *
+ * @param int    $object_id   Traditionally a post ID
+ * @param int    $user_id     User ID
+ * @param string $object_type Type of meta (post,term,user,comment)
  *
  * @return bool
  */
-function bbp_remove_moderator( $object_id = 0, $user_id = 0 ) {
-    return bbp_remove_user_from_object( $object_id, $user_id, '_bbp_moderator_id' );
+function bbp_remove_moderator( $object_id = 0, $user_id = 0, $object_type = 'post' ) {
+    return bbp_remove_user_from_object( $object_id, $user_id, '_bbp_moderator_id', $object_type );
 }
 
@@ -826 +828 @@
  * Get user IDs of moderators for an object
  *
- * @since 2.6.0 bbPress
- *
- * @param int $object_id
- *
- * @return mixed
- */
-function bbp_get_moderator_ids( $object_id = 0 ) {
-    return bbp_get_users_for_object( $object_id, '_bbp_moderator_id' );
+ * @since 2.6.0 bbPress (r6056)
+ *
+ * @param int    $object_id   Traditionally a post ID
+ * @param string $object_type Type of meta (post,term,user,comment)
+ *
+ * @return array
+ */
+function bbp_get_moderator_ids( $object_id = 0, $object_type = 'post' ) {
+    return bbp_get_users_for_object( $object_id, '_bbp_moderator_id', $object_type );
 }
 
@@ -840 +843 @@
  * object ID is empty.
  *
- * @since 2.6.0 bbPress
- *
- * @param int $object_id
+ * @since 2.6.0 bbPress (r6056)
+ *
+ * @param int    $object_id   Traditionally a post ID
+ * @param string $object_type Type of meta (post,term,user,comment)
  *
  * @return array
  */
-function bbp_get_moderators( $object_id = 0 ) {
+function bbp_get_moderators( $object_id = 0, $object_type = 'post' ) {
 
     // Get global moderators
@@ -857 +861 @@
     } else {
         $users = get_users( array(
-            'include' => bbp_get_moderator_ids( $object_id ),
+            'include' => bbp_get_moderator_ids( $object_id, $object_type ),
         ) );
     }
 
     // Filter & return
-    return (array) apply_filters( 'bbp_get_moderators', $users, $object_id );
-}
+    return (array) apply_filters( 'bbp_get_moderators', $users, $object_id, $object_type );
+}