BP_REST_Activity_Endpoint::update_favorite_permissions_check( WP_REST_Request $request )
Check if a given request has access to update user favorites.
Description Description
Parameters Parameters
- $request
-
(Required) Full details about the request.
Return Return
(true|WP_Error)
Source 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() ) ) {
$retval = new WP_Error(
'bp_rest_authorization_required',
__( 'Sorry, you are not allowed to update favorites.', 'buddypress' ),
array(
'status' => rest_authorization_required_code(),
)
);
}
/**
* Filter the activity `update_favorite` permissions check.
*
* @since 5.0.0
*
* @param bool|WP_Error $retval Returned value.
* @param WP_REST_Request $request The request sent to the API.
*/
return apply_filters( 'bp_rest_activity_update_favorite_permissions_check', $retval, $request );
}
Changelog Changelog
| Version | Description |
|---|---|
| 5.0.0 | Introduced. |