Changeset 6422 for trunk/src/includes/users/engagements.php

Timestamp:

05/22/2017 06:09:16 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Users: move user relationships functions into engagements.php.

File:

• trunk/src/includes/users/engagements.php (modified) (1 diff)

trunk/src/includes/users/engagements.php

@@ -10 +10 @@
 // Exit if accessed directly
 defined( 'ABSPATH' ) || exit;
+
+/** User Relationships ********************************************************/
+
+/**
+ * Set a user id on an object
+ *
+ * @since 2.6.0 bbPress (r6109)
+ *
+ * @param int    $object_id The object id
+ * @param int    $user_id   The user id
+ * @param string $meta_key  The relationship key
+ * @param string $meta_type The relationship type
+ *
+ * @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 );
+
+    return (bool) apply_filters( 'bbp_add_user_to_object', (bool) $retval, $object_id, $user_id, $meta_key, $meta_type );
+}
+
+/**
+ * Remove a user id from an object
+ *
+ * @since 2.6.0 bbPress (r6109)
+ *
+ * @param int    $object_id The post id
+ * @param int    $user_id   The user id
+ * @param string $meta_key  The relationship key
+ * @param string $meta_type The relationship type
+ *
+ * @uses delete_post_meta() To remove the term from the object
+ * @uses apply_filters() Calls 'bbp_remove_user_from_object' with the object
+ *                        id, user id, and taxonomy
+ * @return bool Returns true is the user taxonomy term is removed from the object,
+ *               otherwise false
+ */
+function bbp_remove_user_from_object( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
+    $retval = delete_metadata( $meta_type, $object_id, $meta_key, $user_id, false );
+
+    return (bool) apply_filters( 'bbp_remove_user_from_object', (bool) $retval, $object_id, $user_id, $meta_key, $meta_type );
+}
+
+/**
+ * Get user taxonomy terms for an object
+ *
+ * @since 2.6.0 bbPress (r6109)
+ *
+ * @param int    $object_id The object id
+ * @param string $meta_key  The key used to index this relationship
+ * @param string $meta_type The type of meta to look in
+ *
+ * @uses get_post_meta() To get the user taxonomy terms
+ * @uses apply_filters() Calls 'bbp_get_users_for_object' with the user
+ *                        taxonomy terms, object id, and taxonomy
+ * @return array Returns the user taxonomy terms of the object
+ */
+function bbp_get_users_for_object( $object_id = 0, $meta_key = '', $meta_type = 'post' ) {
+    $meta   = get_metadata( $meta_type, $object_id, $meta_key, false );
+    $retval = wp_parse_id_list( $meta );
+
+    return (array) apply_filters( 'bbp_get_users_for_object', (array) $retval, $object_id, $meta_key, $meta_type );
+}
+
+/**
+ * Check if the user id is set on an object
+ *
+ * @since 2.6.0 bbPress (r6109)
+ *
+ * @param int    $object_id The object id
+ * @param int    $user_id   The user id
+ * @param string $meta_key  The relationship key
+ * @param string $meta_type The relationship type
+ *
+ * @uses get_post_meta() To check if the user id is set on the object
+ * @uses apply_filters() Calls 'bbp_is_object_of_user' with the object id,
+ *                        user id, and taxonomy
+ * @return bool Returns true if the user id is set on the object for the
+ *               taxonomy, otherwise false
+ */
+function bbp_is_object_of_user( $object_id = 0, $user_id = 0, $meta_key = '', $meta_type = 'post' ) {
+    $user_ids = bbp_get_users_for_object( $object_id, $meta_key, $meta_type );
+    $retval   = is_numeric( array_search( $user_id, $user_ids, true ) );
+
+    return (bool) apply_filters( 'bbp_is_object_of_user', (bool) $retval, $object_id, $user_id, $meta_key, $meta_type );
+}
+
+/** Engagements ***************************************************************/
 
 /**