Contents

Code Reference Classes BP_REST_Messages_Endpoint BP_REST_Messages_Endpoint::update_starred_permissions_check()

BP_REST_Messages_Endpoint::update_starred_permissions_check( WP_REST_Request $request )

Check if a given request has access to update user starred messages.

Description

Parameters

$request

(Required) Full details about the request.

Return

(bool|WP_Error)

Source

File: bp-messages/classes/class-bp-rest-messages-endpoint.php

924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
public function update_starred_permissions_check( $request ) {
    $retval    = true;
    $thread_id = messages_get_message_thread_id( $request['id'] );
 
    if ( ! is_user_logged_in() || ! messages_check_thread_access( $thread_id ) ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to star/unstar messages.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the message `update_starred` permissions check.
     *
     * @param bool|WP_Error   $retval  Returned value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_messages_update_starred_permissions_check', $retval, $request );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.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.