Contents

Code Reference Classes BP_REST_Media_Albums_Endpoint BP_REST_Media_Albums_Endpoint::delete_item()

BP_REST_Media_Albums_Endpoint::delete_item( WP_REST_Request $request )

Delete a single album.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

File: bp-media/classes/class-bp-rest-media-albums-endpoint.php

684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
public function delete_item( $request ) {
 
    $medias = $this->assemble_response_data( array( 'album_ids' => array( $request['id'] ) ) );
 
    if ( empty( $medias['albums'] ) ) {
        return new WP_Error(
            'bp_rest_album_invalid_id',
            __( 'Invalid Album ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    $previous = array();
    foreach ( $medias['albums'] as $album ) {
        $previous = $this->prepare_response_for_collection(
            $this->prepare_item_for_response( $album, $request )
        );
    }
 
    if ( ! bp_album_user_can_delete( $request['id'] ) ) {
        return WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to delete this album.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    $status = bp_album_delete( array( 'id' => $request['id'] ) );
 
    // Build the response.
    $response = new WP_REST_Response();
    $response->set_data(
        array(
            'deleted'  => $status,
            'previous' => $previous,
        )
    );
 
    /**
     * Fires after a media is fetched via the REST API.
     *
     * @param WP_REST_Response $response The response data.
     * @param WP_REST_Request  $request  The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_media_get_item', $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-media/bp-media-template.php: bp_album_user_can_delete()

Determine if the current user can delete an album item.
bp-media/classes/class-bp-rest-media-albums-endpoint.php: BP_REST_Media_Albums_Endpoint::assemble_response_data()

Get Albums.
bp-media/classes/class-bp-rest-media-albums-endpoint.php: BP_REST_Media_Albums_Endpoint::prepare_item_for_response()

Prepares activity data for return as an object.
bp-media/classes/class-bp-rest-media-endpoint.php: bp_rest_media_get_item

Fires after a media is fetched via the REST API.
bp-media/bp-media-functions.php: bp_album_delete()

Delete album item.

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.