bp_messages_star_set_action( array $args = array() )

Save or delete star message meta according to a message’s star status.

Description

Parameters

$args

(Optional) Array of arguments.

'action'
(string) The star action. Either 'star' or 'unstar'. Default: 'star'.
'thread_id'
(int) The message thread ID. Default: 0. If not zero, this takes precedence over $message_id.
'message_id'
(int) The indivudal message ID to star or unstar. Default: 0.
'user_id'
(int) The user ID. Defaults to the logged-in user ID.
'bulk'
(bool) Whether to mark all messages in a thread as a certain action. Only relevant when $action is 'unstar' at the moment. Default: false.

Default value: array()

Return

(bool)

Source

File: bp-messages/bp-messages-star.php

function bp_messages_star_set_action( $args = array() ) {
    $r = wp_parse_args( $args, array(
        'action'     => 'star',
        'thread_id'  => 0,
        'message_id' => 0,
        'user_id'    => bp_displayed_user_id(),
        'bulk'       => false
    ) );
 
    // Set thread ID.
    if ( ! empty( $r['thread_id'] ) ) {
        $thread_id = (int) $r['thread_id'];
    } else {
        $thread_id = messages_get_message_thread_id( $r['message_id'] );
    }
    if ( empty( $thread_id ) ) {
        return false;
    }
 
    // Check if user has access to thread.
    if( ! messages_check_thread_access( $thread_id, $r['user_id'] ) ) {
        return false;
    }
 
    $is_starred = bp_messages_is_message_starred( $r['message_id'], $r['user_id'] );
 
    // Star.
    if ( 'star' == $r['action'] ) {
        if ( true === $is_starred ) {
            return true;
        } else {
            bp_messages_add_meta( $r['message_id'], 'starred_by_user', $r['user_id'] );
            return true;
        }
    // Unstar.
    } else {
        // Unstar one message.
        if ( false === $r['bulk'] ) {
            if ( false === $is_starred ) {
                return true;
            } else {
                bp_messages_delete_meta( $r['message_id'], 'starred_by_user', $r['user_id'] );
                return true;
            }
 
        // Unstar all messages in a thread.
        } else {
            $thread = new BP_Messages_Thread( $thread_id );
            $mids = wp_list_pluck( $thread->messages, 'id' );
 
            foreach ( $mids as $mid ) {
                if ( true === bp_messages_is_message_starred( $mid, $r['user_id'] ) ) {
                    bp_messages_delete_meta( $mid, 'starred_by_user', $r['user_id'] );
                }
            }
 
            return true;
        }
    }
}

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-star.php: bp_messages_is_message_starred()	Function to determine if a message ID is starred.
bp-messages/classes/class-bp-messages-thread.php: BP_Messages_Thread::__construct()	Constructor.
bp-messages/bp-messages-functions.php: messages_get_message_thread_id()	Get the thread ID from a message ID.
bp-messages/bp-messages-functions.php: bp_messages_add_meta()	Add a piece of message metadata.
bp-messages/bp-messages-functions.php: bp_messages_delete_meta()	Delete metadata for a message.
bp-messages/bp-messages-functions.php: messages_check_thread_access()	Check whether a user has access to a thread.
bp-core/bp-core-template.php: bp_displayed_user_id()	Get the ID of the currently displayed user.

Show 2 more uses Hide more uses

Used By
Used By	Description
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/actions/bulk-manage-star.php: bp_messages_star_bulk_manage_handler()	Bulk manage handler to set the star status for multiple messages.
bp-messages/actions/star.php: bp_messages_star_action_handler()	Action handler to set a message’s star status for those not using JS.
bp-templates/bp-nouveau/includes/messages/ajax.php: bp_nouveau_ajax_star_thread_messages()	AJAX mark message with star.

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