Changeset 12984 for trunk/src/bp-messages/bp-messages-functions.php

Timestamp:

07/02/2021 01:10:12 AM (3 years ago)

Author:

espellcaste

Message:

Adding a user ID parameter to the messages_mark_thread_read and messages_mark_thread_unread functions.

Allowing those functions to be used in other BuddyPress API.

Props imath
Fixes #8489 (trunk)

File:

• trunk/src/bp-messages/bp-messages-functions.php (modified) (2 diffs)

trunk/src/bp-messages/bp-messages-functions.php

@@ -325 +325 @@
  * Wrapper for {@link BP_Messages_Thread::mark_as_read()}.
  *
- * @param int $thread_id ID of the thread.
+ * @since 9.0.0 Added the `user_id` parameter.
+ *
+ * @param int $thread_id The message thread ID.
+ * @param int $user_id   Optional. The user the thread will be marked as read.
  *
  * @return false|int Number of threads marked as read or false on error.
  */
-function messages_mark_thread_read( $thread_id ) {
-    return BP_Messages_Thread::mark_as_read( $thread_id );
+function messages_mark_thread_read( $thread_id, $user_id = 0 ) {
+    return BP_Messages_Thread::mark_as_read( $thread_id, $user_id );
 }
 
@@ -338 +341 @@
  * Wrapper for {@link BP_Messages_Thread::mark_as_unread()}.
  *
- * @param int $thread_id ID of the thread.
+ * @since 9.0.0 Added the `user_id` parameter.
+ *
+ * @param int $thread_id The message thread ID.
+ * @param int $user_id   Optional. The user the thread will be marked as unread.
  *
  * @return false|int Number of threads marked as unread or false on error.
  */
-function messages_mark_thread_unread( $thread_id ) {
-    return BP_Messages_Thread::mark_as_unread( $thread_id );
+function messages_mark_thread_unread( $thread_id, $user_id = 0 ) {
+    return BP_Messages_Thread::mark_as_unread( $thread_id, $user_id );
 }