Contents

Code Reference Classes BP_REST_Topics_Endpoint BP_REST_Topics_Endpoint::delete_item()

BP_REST_Topics_Endpoint::delete_item( WP_REST_Request $request )

Delete a topic.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

File: bp-forums/classes/class-bp-rest-topics-endpoint.php

1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
public function delete_item( $request ) {
 
    $topic = get_post( $request['id'] );
 
    $previous = $this->prepare_response_for_collection(
        $this->prepare_item_for_response( $topic, $request )
    );
 
    $success = wp_delete_post( $topic->ID );
 
    // Build the response.
    $response = new WP_REST_Response();
    $response->set_data(
        array(
            'deleted'  => ( ! empty( $success ) && ! is_wp_error( $success ) ? true : $success ),
            'previous' => $previous,
        )
    );
 
    /**
     * Fires after a topic is deleted via the REST API.
     *
     * @param array            $topic    Deleted/Trashed topic.
     * @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_topic_delete_item', $topic, $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

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.