Contents

Code Reference Classes BP_REST_Media_Endpoint BP_REST_Media_Endpoint::delete_item()

BP_REST_Media_Endpoint::delete_item( WP_REST_Request $request )

Delete a single media.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

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

988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
public function delete_item( $request ) {
 
    $id = $request['id'];
 
    $medias = $this->assemble_response_data( array( 'media_ids' => array( $id ) ) );
 
    if ( empty( $medias['medias'] ) ) {
        return new WP_Error(
            'bp_rest_media_id',
            __( 'Invalid media ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    $previous = '';
    foreach ( $medias['medias'] as $media ) {
        $previous = $this->prepare_response_for_collection(
            $this->prepare_item_for_response( $media, $request )
        );
    }
 
    if ( ! bp_media_user_can_delete( $id ) ) {
        return WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to delete this media.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    $status = bp_media_delete( array( 'id' => $id ), true );
 
    // 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_media_user_can_delete()

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

Get medias.
bp-media/classes/class-bp-rest-media-endpoint.php: BP_REST_Media_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_media_delete()

Delete media.

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.