$user_id,
'box' => $default_box,
'per_page' => 10,
'max' => false,
'type' => 'all',
'search_terms' => $search_terms,
'page_arg' => 'mpage', // See https://buddypress.trac.wordpress.org/ticket/3679.
'meta_query' => array(),
'recipients_page' => null,
'recipients_per_page' => null,
'messages_page' => null,
'messages_per_page' => null,
),
'has_message_threads'
);
// Load the messages loop global up with messages.
$messages_template = new BP_Messages_Box_Template( $r );
/**
* Filters if there are any message threads to display in inbox/sentbox/notices.
*
* @since 1.1.0
*
* @param bool $value Whether or not the message has threads.
* @param BP_Messages_Box_Template $messages_template Current message box template object.
* @param array $r Array of parsed arguments passed into function.
*/
return apply_filters( 'bp_has_message_threads', $messages_template->has_threads(), $messages_template, $r );
}
/**
* Check whether there are more threads to iterate over.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return bool
*/
function bp_message_threads() {
global $messages_template;
return $messages_template->message_threads();
}
/**
* Set up the current thread inside the loop.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return BP_Messages_Thread
*/
function bp_message_thread() {
global $messages_template;
return $messages_template->the_message_thread();
}
/**
* Output the ID of the current thread in the loop.
*/
function bp_message_thread_id() {
echo bp_get_message_thread_id();
}
/**
* Get the ID of the current thread in the loop.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return int
*/
function bp_get_message_thread_id() {
global $messages_template;
/**
* Filters the ID of the current thread in the loop.
*
* @since 1.0.0
*
* @param int $thread_id ID of the current thread in the loop.
*/
return apply_filters( 'bp_get_message_thread_id', (int) $messages_template->thread->thread_id );
}
/**
* Output the subject of the current thread in the loop.
*/
function bp_message_thread_subject() {
echo bp_get_message_thread_subject();
}
/**
* Get the subject of the current thread in the loop.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_message_thread_subject() {
global $messages_template;
/**
* Filters the subject of the current thread in the loop.
*
* @since 1.1.0
*
* @param string $value Subject of the current thread in the loop.
*/
return apply_filters( 'bp_get_message_thread_subject', $messages_template->thread->last_message_subject );
}
/**
* Output an excerpt from the current message in the loop.
*/
function bp_message_thread_excerpt() {
echo bp_get_message_thread_excerpt();
}
/**
* Generate an excerpt from the current message in the loop.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_message_thread_excerpt() {
global $messages_template;
/**
* Filters the excerpt of the current thread in the loop.
*
* @since 1.0.0
*
* @param string $value Excerpt of the current thread in the loop.
*/
return apply_filters( 'bp_get_message_thread_excerpt', strip_tags( bp_create_excerpt( $messages_template->thread->last_message_content, 75 ) ) );
}
/**
* Output the thread's last message content.
*
* When viewing your Inbox, the last message is the most recent message in
* the thread of which you are *not* the author.
*
* When viewing your Sentbox, last message is the most recent message in
* the thread of which you *are* the member.
*
* @since 2.0.0
*/
function bp_message_thread_content() {
echo bp_get_message_thread_content();
}
/**
* Return the thread's last message content.
*
* When viewing your Inbox, the last message is the most recent message in
* the thread of which you are *not* the author.
*
* When viewing your Sentbox, last message is the most recent message in
* the thread of which you *are* the member.
*
* @since 2.0.0
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string The raw content of the last message in the thread.
*/
function bp_get_message_thread_content() {
global $messages_template;
/**
* Filters the content of the last message in the thread.
*
* @since 2.0.0
*
* @param string $last_message_content Content of the last message in the thread.
*/
return apply_filters( 'bp_get_message_thread_content', $messages_template->thread->last_message_content );
}
/**
* Output a link to the page of the current thread's last author.
*/
function bp_message_thread_from() {
echo bp_get_message_thread_from();
}
/**
* Get a link to the page of the current thread's last author.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_message_thread_from() {
global $messages_template;
/**
* Filters the link to the page of the current thread's last author.
*
* @since 1.0.0
*
* @param string $value Link to the page of the current thread's last author.
*/
return apply_filters( 'bp_get_message_thread_from', bp_core_get_userlink( $messages_template->thread->last_sender_id ) );
}
/**
* Output links to the pages of the current thread's recipients.
*/
function bp_message_thread_to() {
echo bp_get_message_thread_to();
}
/**
* Generate HTML links to the pages of the current thread's recipients.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_message_thread_to() {
global $messages_template;
/**
* Filters the HTML links to the pages of the current thread's recipients.
*
* @since 1.0.0
*
* @param string $value HTML links to the pages of the current thread's recipients.
*/
return apply_filters( 'bp_message_thread_to', BP_Messages_Thread::get_recipient_links( $messages_template->thread->recipients ) );
}
/**
* Output the permalink for a particular thread.
*
* @since 2.9.0 Introduced `$user_id` parameter.
*
* @param int $thread_id Optional. ID of the thread. Default: current thread
* being iterated on in the loop.
* @param int $user_id Optional. ID of the user relative to whom the link
* should be generated. Default: ID of logged-in user.
*/
function bp_message_thread_view_link( $thread_id = 0, $user_id = null ) {
echo bp_get_message_thread_view_link( $thread_id, $user_id );
}
/**
* Get the permalink of a particular thread.
*
* @since 2.9.0 Introduced `$user_id` parameter.
*
* @global BP_Messages_Box_Template $messages_template
*
* @param int $thread_id Optional. ID of the thread. Default: current
* thread being iterated on in the loop.
* @param int $user_id Optional. ID of the user relative to whom the link
* should be generated. Default: ID of logged-in user.
* @return string
*/
function bp_get_message_thread_view_link( $thread_id = 0, $user_id = null ) {
global $messages_template;
if ( empty( $messages_template ) && (int) $thread_id > 0 ) {
$thread_id = (int) $thread_id;
} elseif ( ! empty( $messages_template->thread->thread_id ) ) {
$thread_id = $messages_template->thread->thread_id;
}
if ( empty( $user_id ) ) {
$user_id = bp_loggedin_user_id();
}
$domain = bp_core_get_user_domain( $user_id );
/**
* Filters the permalink of a particular thread.
*
* @since 1.0.0
* @since 2.6.0 Added the `$thread_id` parameter.
* @since 2.9.0 Added the `$user_id` parameter.
*
* @param string $value Permalink of a particular thread.
* @param int $thread_id ID of the thread.
* @param int $user_id ID of the user.
*/
return apply_filters( 'bp_get_message_thread_view_link', trailingslashit( $domain . bp_get_messages_slug() . '/view/' . $thread_id ), $thread_id, $user_id );
}
/**
* Output the URL for deleting the current thread.
*
* @since 2.9.0 Introduced `$user_id` parameter.
*
* @param int|null $user_id Optional. ID of the user relative to whom the link
* should be generated. Default: ID of logged-in user.
*/
function bp_message_thread_delete_link( $user_id = null ) {
echo esc_url( bp_get_message_thread_delete_link( $user_id ) );
}
/**
* Generate the URL for deleting the current thread.
*
* @since 2.9.0 Introduced `$user_id` parameter.
*
* @global BP_Messages_Box_Template $messages_template
*
* @param int|null $user_id Optional. ID of the user relative to whom the link
* should be generated. Default: ID of logged-in user.
* @return string
*/
function bp_get_message_thread_delete_link( $user_id = null ) {
global $messages_template;
if ( empty( $user_id ) ) {
$user_id = bp_loggedin_user_id();
}
$domain = bp_core_get_user_domain( $user_id );
/**
* Filters the URL for deleting the current thread.
*
* @since 1.0.0
*
* @param string $value URL for deleting the current thread.
* @param int $user_id ID of the user relative to whom the link should be generated.
*/
return apply_filters( 'bp_get_message_thread_delete_link', wp_nonce_url( trailingslashit( $domain . bp_get_messages_slug() . '/' . bp_current_action() . '/delete/' . $messages_template->thread->thread_id ), 'messages_delete_thread' ), $user_id );
}
/**
* Output the URL used for marking a single message thread as unread.
*
* Since this function directly outputs a URL, it is escaped.
*
* @since 2.2.0
* @since 2.9.0 Introduced `$user_id` parameter.
*
* @param int|null $user_id Optional. ID of the user relative to whom the link
* should be generated. Default: ID of logged-in user.
*/
function bp_the_message_thread_mark_unread_url( $user_id = null ) {
echo esc_url( bp_get_the_message_thread_mark_unread_url( $user_id ) );
}
/**
* Return the URL used for marking a single message thread as unread.
*
* @since 2.2.0
* @since 2.9.0 Introduced `$user_id` parameter.
*
* @param int|null $user_id Optional. ID of the user relative to whom the link
* should be generated. Default: ID of logged-in user.
* @return string
*/
function bp_get_the_message_thread_mark_unread_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' => 'unread',
'message_id' => $id,
);
if ( empty( $user_id ) ) {
$user_id = bp_loggedin_user_id();
}
$domain = bp_core_get_user_domain( $user_id );
// Base unread URL.
$url = trailingslashit( $domain . bp_get_messages_slug() . '/' . bp_current_action() . '/unread' );
// Add the args to the URL.
$url = add_query_arg( $args, $url );
// Add the nonce.
$url = wp_nonce_url( $url, 'bp_message_thread_mark_unread_' . $id );
/**
* Filters the URL used for marking a single message thread as unread.
*
* @since 2.2.0
* @since 2.9.0 Added `$user_id` parameter.
*
* @param string $url URL used for marking a single message thread as unread.
* @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_unread_url', $url, $user_id );
}
/**
* Output the URL used for marking a single message thread as read.
*
* Since this function directly outputs a URL, it is escaped.
*
* @since 2.2.0
* @since 2.9.0 Introduced `$user_id` parameter.
*
* @param int|null $user_id Optional. ID of the user relative to whom the link
* should be generated. Default: ID of logged-in user.
*/
function bp_the_message_thread_mark_read_url( $user_id = null ) {
echo esc_url( bp_get_the_message_thread_mark_read_url( $user_id ) );
}
/**
* Return the URL used for marking a single message thread as read.
*
* @since 2.2.0
* @since 2.9.0 Introduced `$user_id` parameter.
*
* @param int|null $user_id Optional. ID of the user relative to whom the link
* should be generated. Default: ID of logged-in user.
* @return string
*/
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 ( empty( $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 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, $user_id );
}
/**
* Output the CSS class for the current thread.
*/
function bp_message_css_class() {
echo esc_attr( bp_get_message_css_class() );
}
/**
* Generate the CSS class for the current thread.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_message_css_class() {
global $messages_template;
$class = false;
if ( $messages_template->current_thread % 2 === 1 ) {
$class .= 'alt';
}
/**
* Filters the CSS class for the current thread.
*
* @since 1.2.10
*
* @param string $class Class string to be added to the list of classes.
*/
return apply_filters( 'bp_get_message_css_class', trim( $class ) );
}
/**
* Check whether the current thread has unread items.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return bool True if there are unread items, otherwise false.
*/
function bp_message_thread_has_unread() {
global $messages_template;
$retval = ! empty( $messages_template->thread->unread_count );
/**
* Filters whether or not a message thread has unread items.
*
* @since 2.1.0
*
* @param bool $retval Whether or not a message thread has unread items.
*/
return apply_filters( 'bp_message_thread_has_unread', $retval );
}
/**
* Output the current thread's unread count.
*/
function bp_message_thread_unread_count() {
echo esc_html( bp_get_message_thread_unread_count() );
}
/**
* Get the current thread's unread count.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return int
*/
function bp_get_message_thread_unread_count() {
global $messages_template;
$count = ! empty( $messages_template->thread->unread_count )
? (int) $messages_template->thread->unread_count
: false;
/**
* Filters the current thread's unread count.
*
* @since 1.0.0
*
* @param int $count Current thread unread count.
*/
return apply_filters( 'bp_get_message_thread_unread_count', (int) $count );
}
/**
* Output a thread's total message count.
*
* @since 2.2.0
*
* @param int|bool $thread_id Optional. ID of the thread. Defaults to current thread ID.
*/
function bp_message_thread_total_count( $thread_id = false ) {
echo bp_get_message_thread_total_count( $thread_id );
}
/**
* Get the current thread's total message count.
*
* @since 2.2.0
*
* @param int|bool $thread_id Optional. ID of the thread.
* Defaults to current thread ID.
* @return int
*/
function bp_get_message_thread_total_count( $thread_id = false ) {
if ( false === $thread_id ) {
$thread_id = bp_get_message_thread_id();
}
$thread_template = new BP_Messages_Thread_Template( $thread_id, 'ASC', array(
'update_meta_cache' => false
) );
$count = 0;
if ( ! empty( $thread_template->message_count ) ) {
$count = intval( $thread_template->message_count );
}
/**
* Filters the current thread's total message count.
*
* @since 2.2.0
* @since 2.6.0 Added the `$thread_id` parameter.
*
* @param int $count Current thread total message count.
* @param int $thread_id ID of the queried thread.
*/
return apply_filters( 'bp_get_message_thread_total_count', $count, $thread_id );
}
/**
* Output markup for the current thread's total and unread count.
*
* @since 2.2.0
*
* @param int|bool $thread_id Optional. ID of the thread. Default: current thread ID.
*/
function bp_message_thread_total_and_unread_count( $thread_id = false ) {
echo bp_get_message_thread_total_and_unread_count( $thread_id );
}
/**
* Get markup for the current thread's total and unread count.
*
* @param int|bool $thread_id Optional. ID of the thread. Default: current thread ID.
* @return string Markup displaying the total and unread count for the thread.
*/
function bp_get_message_thread_total_and_unread_count( $thread_id = false ) {
if ( false === $thread_id ) {
$thread_id = bp_get_message_thread_id();
}
$total = bp_get_message_thread_total_count( $thread_id );
$unread = bp_get_message_thread_unread_count( $thread_id );
return sprintf(
/* translators: 1: total number, 2: accessibility text: number of unread messages */
'(%1$s)%2$s',
number_format_i18n( $total ),
/* translators: %d: number of unread messages */
sprintf( _n( '%d unread', '%d unread', $unread, 'buddypress' ), number_format_i18n( $unread ) )
);
}
/**
* Output the unformatted date of the last post in the current thread.
*/
function bp_message_thread_last_post_date_raw() {
echo bp_get_message_thread_last_post_date_raw();
}
/**
* Get the unformatted date of the last post in the current thread.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_message_thread_last_post_date_raw() {
global $messages_template;
/**
* Filters the unformatted date of the last post in the current thread.
*
* @since 2.1.0
*
* @param string $last_message_date Unformatted date of the last post in the current thread.
*/
return apply_filters( 'bp_get_message_thread_last_message_date', $messages_template->thread->last_message_date );
}
/**
* Output the nicely formatted date of the last post in the current thread.
*/
function bp_message_thread_last_post_date() {
echo bp_get_message_thread_last_post_date();
}
/**
* Get the nicely formatted date of the last post in the current thread.
*
* @return string
*/
function bp_get_message_thread_last_post_date() {
/**
* Filters the nicely formatted date of the last post in the current thread.
*
* @since 2.1.0
*
* @param string $value Formatted date of the last post in the current thread.
*/
return apply_filters( 'bp_get_message_thread_last_post_date', bp_format_time( strtotime( bp_get_message_thread_last_post_date_raw() ) ) );
}
/**
* Output the avatar for the last sender in the current message thread.
*
* @see bp_get_message_thread_avatar() for a description of arguments.
*
* @param array|string $args See {@link bp_get_message_thread_avatar()}.
*/
function bp_message_thread_avatar( $args = '' ) {
echo bp_get_message_thread_avatar( $args );
}
/**
* Return the avatar for the last sender in the current message thread.
*
* @see bp_core_fetch_avatar() For a description of arguments and
* return values.
*
* @global BP_Messages_Box_Template $messages_template
*
* @param array|string $args {
* Arguments are listed here with an explanation of their defaults.
* For more information about the arguments, see
* {@link bp_core_fetch_avatar()}.
* @type string $type Default: 'thumb'.
* @type int|bool $width Default: false.
* @type int|bool $height Default: false.
* @type string $class Default: 'avatar'.
* @type string|bool $id Default: false.
* @type string $alt Default: 'Profile picture of [display name]'.
* }
* @return string User avatar string.
*/
function bp_get_message_thread_avatar( $args = '' ) {
global $messages_template;
$fullname = bp_core_get_user_displayname( $messages_template->thread->last_sender_id );
/* translators: %s: member name */
$alt = sprintf( __( 'Profile picture of %s', 'buddypress' ), $fullname );
$r = bp_parse_args(
$args,
array(
'type' => 'thumb',
'width' => false,
'height' => false,
'class' => 'avatar',
'id' => false,
'alt' => $alt,
)
);
/**
* Filters the avatar for the last sender in the current message thread.
*
* @since 1.0.0
* @since 2.6.0 Added the `$r` parameter.
*
* @param string $value User avatar string.
* @param array $r Array of parsed arguments.
*/
return apply_filters( 'bp_get_message_thread_avatar', bp_core_fetch_avatar( array(
'item_id' => $messages_template->thread->last_sender_id,
'type' => $r['type'],
'alt' => $r['alt'],
'css_id' => $r['id'],
'class' => $r['class'],
'width' => $r['width'],
'height' => $r['height'],
) ), $r );
}
/**
* Output the unread messages count for the current inbox.
*
* @since 2.6.x Added the `$user_id` paremeter.
*
* @param int $user_id The user ID.
*/
function bp_total_unread_messages_count( $user_id = 0 ) {
echo bp_get_total_unread_messages_count( $user_id );
}
/**
* Get the unread messages count for the current inbox.
*
* @since 2.6.x Added the `$user_id` paremeter.
*
* @param int $user_id The user ID.
*
* @return int $unread_count Total inbox unread count for user.
*/
function bp_get_total_unread_messages_count( $user_id = 0 ) {
/**
* Filters the unread messages count for the current inbox.
*
* @since 1.0.0
*
* @param int $value Unread messages count for the current inbox.
* @param int $user_id ID of the user the messages are from.
*/
return apply_filters( 'bp_get_total_unread_messages_count', BP_Messages_Thread::get_inbox_count( $user_id ), $user_id );
}
/**
* Output the pagination HTML for the current thread loop.
*/
function bp_messages_pagination() {
echo bp_get_messages_pagination();
}
/**
* Get the pagination HTML for the current thread loop.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_messages_pagination() {
global $messages_template;
/**
* Filters the pagination HTML for the current thread loop.
*
* @since 1.0.0
*
* @param int $pag_links Pagination HTML for the current thread loop.
*/
return apply_filters( 'bp_get_messages_pagination', $messages_template->pag_links );
}
/**
* Generate the "Viewing message x to y (of z messages)" string for a loop.
*
* @global BP_Messages_Box_Template $messages_template
*/
function bp_messages_pagination_count() {
global $messages_template;
$start_num = intval( ( $messages_template->pag_page - 1 ) * $messages_template->pag_num ) + 1;
$from_num = bp_core_number_format( $start_num );
$to_num = bp_core_number_format( ( $start_num + ( $messages_template->pag_num - 1 ) > $messages_template->total_thread_count ) ? $messages_template->total_thread_count : $start_num + ( $messages_template->pag_num - 1 ) );
$total = bp_core_number_format( $messages_template->total_thread_count );
if ( 1 == $messages_template->total_thread_count ) {
$message = __( 'Viewing 1 message', 'buddypress' );
} else {
/* translators: 1: message from number. 2: message to number. 3: total messages. */
$message = sprintf( _n( 'Viewing %1$s - %2$s of %3$s message', 'Viewing %1$s - %2$s of %3$s messages', $messages_template->total_thread_count, 'buddypress' ), $from_num, $to_num, $total );
}
echo esc_html( $message );
}
/**
* Output the Private Message search form.
*
* @todo Move markup to template part in: /members/single/messages/search.php
* @since 1.6.0
*/
function bp_message_search_form() {
// Get the default search text.
$default_search_value = bp_get_search_default_text( 'messages' );
// Setup a few values based on what's being searched for.
$search_submitted = ! empty( $_REQUEST['s'] ) ? stripslashes( $_REQUEST['s'] ) : $default_search_value;
$search_placeholder = ( $search_submitted === $default_search_value ) ? ' placeholder="' . esc_attr( $search_submitted ) . '"' : '';
$search_value = ( $search_submitted !== $default_search_value ) ? ' value="' . esc_attr( $search_submitted ) . '"' : '';
// Start the output buffer, so form can be filtered.
ob_start(); ?>
thread->is_active )
? true
: false;
/**
* Filters whether or not the notice is currently active.
*
* @since 2.1.0
*
* @param bool $retval Whether or not the notice is currently active.
*/
return apply_filters( 'bp_messages_is_active_notice', $retval );
}
/**
* Output a string for the active notice.
*
* Since 1.6 this function has been deprecated in favor of text in the theme.
*
* @since 1.0.0
* @deprecated 1.6.0
*/
function bp_message_is_active_notice() {
echo bp_get_message_is_active_notice();
}
/**
* Returns a string for the active notice.
*
* Since 1.6 this function has been deprecated in favor of text in the
* theme.
*
* @since 1.0.0
* @deprecated 1.6.0
* @return string
*/
function bp_get_message_is_active_notice() {
$string = bp_messages_is_active_notice()
? __( 'Currently Active', 'buddypress' )
: '';
return apply_filters( 'bp_get_message_is_active_notice', $string );
}
/**
* Output the ID of the current notice in the loop.
*/
function bp_message_notice_id() {
echo bp_get_message_notice_id();
}
/**
* Get the ID of the current notice in the loop.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return int
*/
function bp_get_message_notice_id() {
global $messages_template;
/**
* Filters the ID of the current notice in the loop.
*
* @since 1.5.0
*
* @param int $id ID of the current notice in the loop.
*/
return apply_filters( 'bp_get_message_notice_id', (int) $messages_template->thread->id );
}
/**
* Output the post date of the current notice in the loop.
*/
function bp_message_notice_post_date() {
echo bp_get_message_notice_post_date();
}
/**
* Get the post date of the current notice in the loop.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_message_notice_post_date() {
global $messages_template;
/**
* Filters the post date of the current notice in the loop.
*
* @since 1.0.0
*
* @param string $value Formatted post date of the current notice in the loop.
*/
return apply_filters( 'bp_get_message_notice_post_date', bp_format_time( strtotime( $messages_template->thread->date_sent ) ) );
}
/**
* Output the subject of the current notice in the loop.
*
* @since 5.0.0 The $notice parameter has been added.
*
* @param BP_Messages_Notice $notice The notice object.
*/
function bp_message_notice_subject( $notice = null ) {
echo bp_get_message_notice_subject( $notice );
}
/**
* Get the subject of the current notice in the loop.
*
* @since 5.0.0 The $notice parameter has been added.
*
* @global BP_Messages_Box_Template $messages_template
*
* @param BP_Messages_Notice|null $notice The notice object.
* @return string
*/
function bp_get_message_notice_subject( $notice = null ) {
global $messages_template;
if ( ! isset( $notice->subject ) ) {
$notice =& $messages_template->thread;
}
/**
* Filters the subject of the current notice in the loop.
*
* @since 1.0.0
*
* @param string $subject Subject of the current notice in the loop.
*/
return apply_filters( 'bp_get_message_notice_subject', $notice->subject );
}
/**
* Output the text of the current notice in the loop.
*
* @since 5.0.0 The $notice parameter has been added.
*
* @param BP_Messages_Notice $notice The notice object.
*/
function bp_message_notice_text( $notice = null ) {
echo bp_get_message_notice_text( $notice );
}
/**
* Get the text of the current notice in the loop.
*
* @since 5.0.0 The $notice parameter has been added.
*
* @global BP_Messages_Box_Template $messages_template
*
* @param BP_Messages_Notice|null $notice The notice object.
* @return string
*/
function bp_get_message_notice_text( $notice = null ) {
global $messages_template;
if ( ! isset( $notice->subject ) ) {
$notice =& $messages_template->thread;
}
/**
* Filters the text of the current notice in the loop.
*
* @since 1.0.0
*
* @param string $message Text for the current notice in the loop.
*/
return apply_filters( 'bp_get_message_notice_text', $notice->message );
}
/**
* Output the URL for deleting the current notice.
*/
function bp_message_notice_delete_link() {
echo esc_url( bp_get_message_notice_delete_link() );
}
/**
* Get the URL for deleting the current notice.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string Delete URL.
*/
function bp_get_message_notice_delete_link() {
global $messages_template;
/**
* Filters the URL for deleting the current notice.
*
* @since 1.0.0
*
* @param string $value URL for deleting the current notice.
* @param string $value Text indicating action being executed.
*/
return apply_filters( 'bp_get_message_notice_delete_link', wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/notices/delete/' . $messages_template->thread->id ), 'messages_delete_notice' ) );
}
/**
* Output the URL for deactivating the current notice.
*/
function bp_message_activate_deactivate_link() {
echo esc_url( bp_get_message_activate_deactivate_link() );
}
/**
* Get the URL for deactivating the current notice.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_message_activate_deactivate_link() {
global $messages_template;
if ( 1 === (int) $messages_template->thread->is_active ) {
$link = wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/notices/deactivate/' . $messages_template->thread->id ), 'messages_deactivate_notice' );
} else {
$link = wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/notices/activate/' . $messages_template->thread->id ), 'messages_activate_notice' );
}
/**
* Filters the URL for deactivating the current notice.
*
* @since 1.0.0
*
* @param string $link URL for deactivating the current notice.
*/
return apply_filters( 'bp_get_message_activate_deactivate_link', $link );
}
/**
* Output the Deactivate/Activate text for the notice action link.
*/
function bp_message_activate_deactivate_text() {
echo esc_html( bp_get_message_activate_deactivate_text() );
}
/**
* Generate the text ('Deactivate' or 'Activate') for the notice action link.
*
* @global BP_Messages_Box_Template $messages_template
*
* @return string
*/
function bp_get_message_activate_deactivate_text() {
global $messages_template;
if ( 1 === (int) $messages_template->thread->is_active ) {
$text = __('Deactivate', 'buddypress');
} else {
$text = __('Activate', 'buddypress');
}
/**
* Filters the "Deactivate" or "Activate" text for notice action links.
*
* @since 1.0.0
*
* @param string $text Text used for notice action links.
*/
return apply_filters( 'bp_message_activate_deactivate_text', $text );
}
/**
* Output the URL for dismissing the current notice for the current user.
*
* @since 9.0.0
*/
function bp_message_notice_dismiss_link() {
echo esc_url( bp_get_message_notice_dismiss_link() );
}
/**
* Get the URL for dismissing the current notice for the current user.
*
* @since 9.0.0
* @return string URL for dismissing the current notice for the current user.
*/
function bp_get_message_notice_dismiss_link() {
$link = wp_nonce_url( trailingslashit( bp_loggedin_user_domain() . bp_get_messages_slug() . '/notices/dismiss/' ), 'messages_dismiss_notice' );
/**
* Filters the URL for dismissing the current notice for the current user.
*
* @since 9.0.0
*
* @param string $link URL for dismissing the current notice.
*/
return apply_filters( 'bp_get_message_notice_dismiss_link', $link );
}
/**
* Output the messages component slug.
*
* @since 1.5.0
*
*/
function bp_messages_slug() {
echo bp_get_messages_slug();
}
/**
* Return the messages component slug.
*
* @since 1.5.0
*
* @return string
*/
function bp_get_messages_slug() {
/**
* Filters the messages component slug.
*
* @since 1.5.0
*
* @param string $slug Messages component slug.
*/
return apply_filters( 'bp_get_messages_slug', buddypress()->messages->slug );
}
/**
* Generate markup for currently active notices.
*/
function bp_message_get_notices() {
$notice = BP_Messages_Notice::get_active();
if ( empty( $notice ) ) {
return false;
}
$closed_notices = bp_get_user_meta( bp_loggedin_user_id(), 'closed_notices', true );
if ( empty( $closed_notices ) ) {
$closed_notices = array();
}
if ( is_array( $closed_notices ) ) {
if ( ! in_array( $notice->id, $closed_notices, true ) && $notice->id ) {
?>
false,
'order' => 'ASC',
'update_meta_cache' => true,
'page' => null,
'per_page' => null,
),
'thread_has_messages'
);
if ( empty( $r['thread_id'] ) && bp_is_messages_component() && bp_is_current_action( 'view' ) ) {
$r['thread_id'] = (int) bp_action_variable( 0 );
}
// Set up extra args.
$extra_args = $r;
unset( $extra_args['thread_id'], $extra_args['order'] );
$thread_template = new BP_Messages_Thread_Template( $r['thread_id'], $r['order'], $extra_args );
return $thread_template->has_messages();
}
/**
* Output the 'ASC' or 'DESC' messages order string for this loop.
*/
function bp_thread_messages_order() {
echo esc_attr( bp_get_thread_messages_order() );
}
/**
* Get the 'ASC' or 'DESC' messages order string for this loop.
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return string
*/
function bp_get_thread_messages_order() {
global $thread_template;
return $thread_template->thread->messages_order;
}
/**
* Check whether there are more messages to iterate over.
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return bool
*/
function bp_thread_messages() {
global $thread_template;
return $thread_template->messages();
}
/**
* Set up the current thread inside the loop.
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return BP_Messages_Message
*/
function bp_thread_the_message() {
global $thread_template;
return $thread_template->the_message();
}
/**
* Output the ID of the thread that the current loop belongs to.
*/
function bp_the_thread_id() {
echo (int) bp_get_the_thread_id();
}
/**
* Get the ID of the thread that the current loop belongs to.
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return int
*/
function bp_get_the_thread_id() {
global $thread_template;
/**
* Filters the ID of the thread that the current loop belongs to.
*
* @since 1.1.0
*
* @param int $thread_id ID of the thread.
*/
return apply_filters( 'bp_get_the_thread_id', $thread_template->thread->thread_id );
}
/**
* Output the subject of the thread currently being iterated over.
*/
function bp_the_thread_subject() {
echo bp_get_the_thread_subject();
}
/**
* Get the subject of the thread currently being iterated over.
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return string
*/
function bp_get_the_thread_subject() {
global $thread_template;
/**
* Filters the subject of the thread currently being iterated over.
*
* @since 1.1.0
*
* @return string $last_message_subject Subject of the thread currently being iterated over.
*/
return apply_filters( 'bp_get_the_thread_subject', $thread_template->thread->last_message_subject );
}
/**
* Get a list of thread recipients or a "x recipients" string.
*
* In BuddyPress 2.2.0, this parts of this functionality were moved into the
* members/single/messages/single.php template. This function is no longer used
* by BuddyPress.
*
* @return string
*/
function bp_get_the_thread_recipients() {
if ( 5 <= bp_get_thread_recipients_count() ) {
/* translators: %s: number of message recipients */
$recipients = sprintf( __( '%s recipients', 'buddypress' ), number_format_i18n( bp_get_thread_recipients_count() ) );
} else {
$recipients = bp_get_thread_recipients_list();
}
/**
* Filters the thread recipients.
*
* @since 10.0.0
*
* @param string $recipients List of thread recipients.
*/
return apply_filters( 'bp_get_the_thread_recipients', $recipients );
}
/**
* Get the number of recipients in the current thread.
*
* @since 2.2.0
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return int
*/
function bp_get_thread_recipients_count() {
global $thread_template;
/**
* Filters the total number of recipients in a thread.
*
* @since 2.8.0
*
* @param int $count Total recipients number.
*/
return (int) apply_filters( 'bp_get_thread_recipients_count', count( $thread_template->thread->recipients ) );
}
/**
* Get the max number of recipients to list in the 'Conversation between...' gloss.
*
* @since 2.3.0
*
* @return int
*/
function bp_get_max_thread_recipients_to_list() {
/**
* Filters the max number of recipients to list in the 'Conversation between...' gloss.
*
* @since 2.3.0
*
* @param int $count Recipient count. Default: 5.
*/
return (int) apply_filters( 'bp_get_max_thread_recipients_to_list', 5 );
}
/**
* Output HTML links to recipients in the current thread.
*
* @since 2.2.0
*/
function bp_the_thread_recipients_list() {
echo bp_get_thread_recipients_list();
}
/**
* Generate HTML links to the profiles of recipients in the current thread.
*
* @since 2.2.0
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return string
*/
function bp_get_thread_recipients_list() {
global $thread_template;
$recipient_links = array();
foreach( (array) $thread_template->thread->recipients as $recipient ) {
if ( (int) $recipient->user_id !== bp_loggedin_user_id() ) {
$recipient_link = bp_core_get_userlink( $recipient->user_id );
if ( empty( $recipient_link ) ) {
$recipient_link = __( 'Deleted User', 'buddypress' );
}
$recipient_links[] = $recipient_link;
} else {
$recipient_links[] = __( 'you', 'buddypress' );
}
}
// Concatenate to natural language string.
$recipient_links = wp_sprintf_l( '%l', $recipient_links );
/**
* Filters the HTML links to the profiles of recipients in the current thread.
*
* @since 2.2.0
*
* @param string $value Comma-separated list of recipient HTML links for current thread.
*/
return apply_filters( 'bp_get_the_thread_recipients_list', $recipient_links );
}
/**
* Echo the ID of the current message in the thread.
*
* @since 1.9.0
*/
function bp_the_thread_message_id() {
echo bp_get_the_thread_message_id();
}
/**
* Get the ID of the current message in the thread.
*
* @since 1.9.0
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return int
*/
function bp_get_the_thread_message_id() {
global $thread_template;
$thread_message_id = isset( $thread_template->message->id )
? (int) $thread_template->message->id
: 0;
/**
* Filters the ID of the current message in the thread.
*
* @since 1.9.0
*
* @param int $thread_message_id ID of the current message in the thread.
*/
return (int) apply_filters( 'bp_get_the_thread_message_id', (int) $thread_message_id );
}
/**
* Output the CSS classes for messages within a single thread.
*
* @since 2.1.0
*/
function bp_the_thread_message_css_class() {
echo esc_attr( bp_get_the_thread_message_css_class() );
}
/**
* Generate the CSS classes for messages within a single thread.
*
* @since 2.1.0
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return string
*/
function bp_get_the_thread_message_css_class() {
global $thread_template;
$classes = array();
// Zebra-striping.
$classes[] = bp_get_the_thread_message_alt_class();
// ID of the sender.
$classes[] = 'sent-by-' . intval( $thread_template->message->sender_id );
// Whether the sender is the same as the logged-in user.
if ( bp_loggedin_user_id() === $thread_template->message->sender_id ) {
$classes[] = 'sent-by-me';
}
/**
* Filters the CSS classes for messages within a single thread.
*
* @since 2.1.0
*
* @param array $classes Array of classes to add to the HTML class attribute.
*/
$classes = apply_filters( 'bp_get_the_thread_message_css_class', $classes );
return implode( ' ', $classes );
}
/**
* Output the CSS class used for message zebra striping.
*/
function bp_the_thread_message_alt_class() {
echo esc_attr( bp_get_the_thread_message_alt_class() );
}
/**
* Get the CSS class used for message zebra striping.
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return string
*/
function bp_get_the_thread_message_alt_class() {
global $thread_template;
$class = 'odd';
if ( 1 === $thread_template->current_message % 2 ) {
$class = 'even alt';
}
/**
* Filters the CSS class used for message zebra striping.
*
* @since 1.1.0
*
* @param string $class Class determined to be next for zebra striping effect.
*/
return apply_filters( 'bp_get_the_thread_message_alt_class', $class );
}
/**
* Output the ID for message sender within a single thread.
*
* @since 2.1.0
*/
function bp_the_thread_message_sender_id() {
echo bp_get_the_thread_message_sender_id();
}
/**
* Return the ID for message sender within a single thread.
*
* @since 2.1.0
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return int
*/
function bp_get_the_thread_message_sender_id() {
global $thread_template;
$user_id = ! empty( $thread_template->message->sender_id )
? $thread_template->message->sender_id
: 0;
/**
* Filters the ID for message sender within a single thread.
*
* @since 2.1.0
*
* @param int $user_id ID of the message sender.
*/
return (int) apply_filters( 'bp_get_the_thread_message_sender_id', (int) $user_id );
}
/**
* Output the avatar for the current message sender.
*
* @param array|string $args See {@link bp_get_the_thread_message_sender_avatar_thumb()}
* for a description.
*/
function bp_the_thread_message_sender_avatar( $args = '' ) {
echo bp_get_the_thread_message_sender_avatar_thumb( $args );
}
/**
* Get the avatar for the current message sender.
*
* @global BP_Messages_Thread_Template $thread_template
*
* @param array|string $args {
* Array of arguments. See {@link bp_core_fetch_avatar()} for more
* complete details. All arguments are optional.
* @type string $type Avatar type. Default: 'thumb'.
* @type int $width Avatar width. Default: default for your $type.
* @type int $height Avatar height. Default: default for your $type.
* }
* @return string tag containing the avatar.
*/
function bp_get_the_thread_message_sender_avatar_thumb( $args = '' ) {
global $thread_template;
$r = bp_parse_args(
$args,
array(
'type' => 'thumb',
'width' => false,
'height' => false,
)
);
/**
* Filters the avatar for the current message sender.
*
* @since 1.1.0
* @since 2.6.0 Added the `$r` parameter.
*
* @param string $value tag containing the avatar value.
* @param array $r Array of parsed arguments.
*/
return apply_filters( 'bp_get_the_thread_message_sender_avatar_thumb', bp_core_fetch_avatar( array(
'item_id' => $thread_template->message->sender_id,
'type' => $r['type'],
'width' => $r['width'],
'height' => $r['height'],
'alt' => bp_core_get_user_displayname( $thread_template->message->sender_id )
) ), $r );
}
/**
* Output a link to the sender of the current message.
*
* @since 1.1.0
*/
function bp_the_thread_message_sender_link() {
echo esc_url( bp_get_the_thread_message_sender_link() );
}
/**
* Get a link to the sender of the current message.
*
* @since 1.1.0
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return string
*/
function bp_get_the_thread_message_sender_link() {
global $thread_template;
/**
* Filters the link to the sender of the current message.
*
* @since 1.1.0
*
* @param string $value Link to the sender of the current message.
*/
return apply_filters( 'bp_get_the_thread_message_sender_link', bp_core_get_userlink( $thread_template->message->sender_id, false, true ) );
}
/**
* Output the display name of the sender of the current message.
*
* @since 1.1.0
*/
function bp_the_thread_message_sender_name() {
echo esc_html( bp_get_the_thread_message_sender_name() );
}
/**
* Get the display name of the sender of the current message.
*
* @since 1.1.0
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return string
*/
function bp_get_the_thread_message_sender_name() {
global $thread_template;
$display_name = bp_core_get_user_displayname( $thread_template->message->sender_id );
if ( empty( $display_name ) ) {
$display_name = __( 'Deleted User', 'buddypress' );
}
/**
* Filters the display name of the sender of the current message.
*
* @since 1.1.0
*
* @param string $display_name Display name of the sender of the current message.
*/
return apply_filters( 'bp_get_the_thread_message_sender_name', $display_name );
}
/**
* Output the URL for deleting the current thread.
*
* @since 1.5.0
*/
function bp_the_thread_delete_link() {
echo esc_url( bp_get_the_thread_delete_link() );
}
/**
* Get the URL for deleting the current thread.
*
* @since 1.5.0
*
* @return string URL
*/
function bp_get_the_thread_delete_link() {
/**
* Filters the URL for deleting the current thread.
*
* @since 1.0.0
*
* @param string $value URL for deleting the current thread.
* @param string $value Text indicating action being executed.
*/
return apply_filters( 'bp_get_message_thread_delete_link', wp_nonce_url( bp_displayed_user_domain() . bp_get_messages_slug() . '/inbox/delete/' . bp_get_the_thread_id(), 'messages_delete_thread' ) );
}
/**
* Output the URL to exit the current thread.
*
* @since 10.0.0
*/
function bp_the_thread_exit_link() {
echo esc_url( bp_get_the_thread_exit_link() );
}
/**
* Get the URL to exit the current thread.
*
* @since 10.0.0
*
* @return string URL
*/
function bp_get_the_thread_exit_link() {
/**
* Filters the URL to exit the current thread.
*
* @since 1.0.0
*
* @param string $value URL to exit the current thread.
* @param string $value Text indicating action being executed.
*/
return apply_filters( 'bp_get_the_thread_exit_link', wp_nonce_url( bp_displayed_user_domain() . bp_get_messages_slug() . '/inbox/exit/' . bp_get_the_thread_id(), 'bp_messages_exit_thread' ) );
}
/**
* Output the 'Sent x hours ago' string for the current message.
*
* @since 1.1.0
*/
function bp_the_thread_message_time_since() {
echo bp_get_the_thread_message_time_since();
}
/**
* Generate the 'Sent x hours ago' string for the current message.
*
* @since 1.1.0
*
* @return string
*/
function bp_get_the_thread_message_time_since() {
/**
* Filters the 'Sent x hours ago' string for the current message.
*
* @since 1.1.0
*
* @param string $value Default text of 'Sent x hours ago'.
*/
return apply_filters(
'bp_get_the_thread_message_time_since',
sprintf(
/* translators: %s: last activity timestamp (e.g. "active 1 hour ago") */
__( 'Sent %s', 'buddypress' ),
bp_core_time_since( bp_get_the_thread_message_date_sent() )
)
);
}
/**
* Output the timestamp for the current message.
*
* @since 2.1.0
*/
function bp_the_thread_message_date_sent() {
echo bp_get_the_thread_message_date_sent();
}
/**
* Generate the 'Sent x hours ago' string for the current message.
*
* @since 2.1.0
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return int
*/
function bp_get_the_thread_message_date_sent() {
global $thread_template;
/**
* Filters the date sent value for the current message as a timestamp.
*
* @since 2.1.0
*
* @param string $value Timestamp of the date sent value for the current message.
*/
return apply_filters( 'bp_get_the_thread_message_date_sent', strtotime( $thread_template->message->date_sent ) );
}
/**
* Output the content of the current message in the loop.
*
* @since 1.1.0
*/
function bp_the_thread_message_content() {
echo bp_get_the_thread_message_content();
}
/**
* Get the content of the current message in the loop.
*
* @since 1.1.0
*
* @global BP_Messages_Thread_Template $thread_template
*
* @return string
*/
function bp_get_the_thread_message_content() {
global $thread_template;
$content = $thread_template->message->message;
// If user was deleted, mark content as deleted.
if ( false === bp_core_get_core_userdata( bp_get_the_thread_message_sender_id() ) ) {
$content = esc_html__( '[deleted]', 'buddypress' );
}
/**
* Filters the content of the current message in the loop.
*
* @since 1.1.0
*
* @param string $message The content of the current message in the loop.
*/
return apply_filters( 'bp_get_the_thread_message_content', $content );
}
/** Embeds *******************************************************************/
/**
* Enable oEmbed support for Messages.
*
* @since 1.5.0
*
* @see BP_Embed
*/
function bp_messages_embed() {
add_filter( 'embed_post_id', 'bp_get_the_thread_message_id' );
add_filter( 'bp_embed_get_cache', 'bp_embed_message_cache', 10, 3 );
add_action( 'bp_embed_update_cache', 'bp_embed_message_save_cache', 10, 3 );
}
add_action( 'thread_loop_start', 'bp_messages_embed' );
/**
* Fetch a private message item's cached embeds.
*
* Used during {@link BP_Embed::parse_oembed()} via {@link bp_messages_embed()}.
*
* @since 2.2.0
*
* @param string $cache An empty string passed by BP_Embed::parse_oembed() for
* functions like this one to filter.
* @param int $id The ID of the message item.
* @param string $cachekey The cache key generated in BP_Embed::parse_oembed().
* @return mixed The cached embeds for this message item.
*/
function bp_embed_message_cache( $cache, $id, $cachekey ) {
return bp_messages_get_meta( $id, $cachekey );
}
/**
* Set a private message item's embed cache.
*
* Used during {@link BP_Embed::parse_oembed()} via {@link bp_messages_embed()}.
*
* @since 2.2.0
*
* @param string $cache An empty string passed by BP_Embed::parse_oembed() for
* functions like this one to filter.
* @param string $cachekey The cache key generated in BP_Embed::parse_oembed().
* @param int $id The ID of the message item.
*/
function bp_embed_message_save_cache( $cache, $cachekey, $id ) {
bp_messages_update_meta( $id, $cachekey, $cache );
}