BP_REST_Notifications_Endpoint::get_item_permissions_check( WP_REST_Request $request )

Check if a given request has access to get information about a specific notification.

Description

Parameters

$request: (Required) Full data about the request.

Return

(WP_Error|bool)

Source

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

public function get_item_permissions_check( $request ) {
    $retval = true;
 
    if ( ! is_user_logged_in() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to see the notification.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    $notification = $this->get_notification_object( $request );
 
    if ( true === $retval && is_null( $notification->item_id ) ) {
        $retval = new WP_Error(
            'bp_rest_notification_invalid_id',
            __( 'Invalid notification ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( true === $retval && ! $this->can_see( $notification->id ) ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you cannot view this notification.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the notifications `get_item` 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_notifications_get_item_permissions_check', $retval, $request );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
0.1.0	Introduced.

Uses

Uses
Uses	Description
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::get_notification_object()	Get notification object.
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::can_see()	Can this user see the notification?
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: bp_rest_notifications_get_item_permissions_check	Filter the notifications `get_item` permissions check.

Used By
Used By	Description
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::update_item_permissions_check()	Check if a given request has access to update a notification.
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::delete_item_permissions_check()	Check if a given request has access to delete a notification.

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