bp_get_the_message_thread_mark_read_url( int $user_id = null )
Return the URL used for marking a single message thread as read.
Description
Parameters
- $user_id
-
(Optional) ID of the user relative to whom the link should be generated. Default: ID of logged-in user.
Default value: null
Return
(string)
Source
File: bp-messages/bp-messages-template.php
function bp_get_the_message_thread_mark_read_url( $user_id = null ) {
// Get the message ID.
$id = bp_get_message_thread_id();
// Get the args to add to the URL.
$args = array(
'action' => 'read',
'message_id' => $id
);
if ( null === $user_id ) {
$user_id = bp_loggedin_user_id();
}
$domain = bp_core_get_user_domain( $user_id );
// Base read URL.
$url = trailingslashit( $domain . bp_get_messages_slug() . '/' . bp_current_action() . '/read' );
// Add the args to the URL.
$url = add_query_arg( $args, $url );
// Add the nonce.
$url = wp_nonce_url( $url, 'bp_message_thread_mark_read_' . $id );
/**
* Filters the URL used for marking a single message thread as read.
*
* @since BuddyPress 2.2.0
*
* @param string $url URL used for marking a single message thread as read.
* @param int $user_id ID of the user relative to whom the link should be generated.
*/
return apply_filters( 'bp_get_the_message_thread_mark_read_url', $url );
}
Changelog
| Version | Description |
|---|---|
| BuddyPress 2.2.0 | Introduced. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.