BP_REST_Activity_Endpoint::update_favorite_permissions_check( WP_REST_Request $request )

Check if a given request has access to update user favorites.

Description

Parameters

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

Return

(bool|WP_Error)

Source

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

public function update_favorite_permissions_check( $request ) {
    $retval = true;
 
    if (
        ! ( is_user_logged_in() && bp_activity_can_favorite() )
        || function_exists( 'bp_is_activity_like_active' ) && true !== bp_is_activity_like_active()
    ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to update favorites.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the activity `update_favorite` 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_activity_update_favorite_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-activity/classes/class-bp-rest-activity-endpoint.php: bp_rest_activity_update_favorite_permissions_check	Filter the activity `update_favorite` permissions check.
bp-core/bp-core-options.php: bp_is_activity_like_active()	Check whether Activity Like is enabled.
bp-activity/bp-activity-template.php: bp_activity_can_favorite()	Determine whether favorites are allowed.

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