bp_messages_is_message_starred( int $mid, int $user_id )

Function to determine if a message ID is starred.

Description

Parameters

$mid: (Required) The message ID. Please note that this isn't the message thread ID.
$user_id: (Required) The user ID.

Return

(bool)

Source

function bp_messages_is_message_starred( $mid = 0, $user_id = 0 ) {
	if ( empty( $user_id ) ) {
		$user_id = bp_displayed_user_id();
	}

	if ( empty( $mid ) ) {
		return false;
	}

	$starred = array_flip( (array) bp_messages_get_meta( $mid, 'starred_by_user', false ) );

	if ( isset( $starred[$user_id] ) ) {
		return true;
	} else {
		return false;
	}
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.3.0	Introduced.

Uses

Uses
Uses	Description
bp-messages/bp-messages-functions.php: bp_messages_get_meta()	Get a piece of message metadata.
bp-core/bp-core-template.php: bp_displayed_user_id()	Get the ID of the currently displayed user.

Used By
Used By	Description
bp-messages/classes/class-bp-rest-messages-endpoint.php: BP_REST_Messages_Endpoint::prepare_message_for_response()	Prepares message data for the REST response.
bp-messages/classes/class-bp-rest-messages-endpoint.php: BP_REST_Messages_Endpoint::update_starred()	Adds or removes the message from the current user’s starred box.
bp-messages/bp-messages-star.php: bp_get_the_message_star_action_link()	Return the link or raw URL for starring or unstarring a message.
bp-messages/bp-messages-star.php: bp_messages_star_set_action()	Save or delete star message meta according to a message’s star status.
bp-messages/bp-messages-star.php: bp_messages_star_message_css_class()	Add CSS class for the current message depending on starred status.

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.

Contents