Changeset 6518

Timestamp:

06/10/2017 08:15:37 PM (8 years ago)

Author:

johnjamesjacoby

Message:

Engagements: Update bbp_add_user_object().

• New phpdoc description
• Add $unique parameter and default to true (this differs from the normal false default of add_metadata() because, by default, this API assumes no 1 user can have multiple relationships with the same object)
• Pass $unique into apply_filters()

See #3068.

File:

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

trunk/src/includes/users/engagements.php

@@ -14 +14 @@
 
 /**
- * Set a user id on an object
+ * Add a user id to an object
  *
  * @since 2.6.0 bbPress (r6109)
@@ -22 +22 @@
  * @param string $meta_key  The relationship key
  * @param string $meta_type The relationship type
+ * @param bool   $unique    Whether metadata should be unique to the object
  *
  * @uses add_post_meta() To set the term on the object
- * @uses apply_filters() Calls 'bbp_add_user_to_object' with the object id, user
- *                        id, and taxonomy
- * @return bool Returns true if the user taxonomy term is added to the object,
- *               otherwise false
- */
-function bbp_add_user_to_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
-    $retval = add_metadata( $meta_type, $object_id, $meta_key, $user_id, false );
-
-    // Filter & return
-    return (bool) apply_filters( 'bbp_add_user_to_object', (bool) $retval, $object_id, $user_id, $meta_key, $meta_type );
+ * @uses apply_filters() Calls 'bbp_add_user_to_object' with the return value & parameters
+ * @return bool Returns true if the user is added to the object, otherwise false
+ */
+function bbp_add_user_to_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post', $unique = true ) {
+    $retval = add_metadata( $meta_type, $object_id, $meta_key, $user_id, $unique );
+
+    // Filter & return
+    return (bool) apply_filters( 'bbp_add_user_to_object', (bool) $retval, $object_id, $user_id, $meta_key, $meta_type, $unique );
 }