BP_REST_Activity_Comment_Endpoint::prepare_activity_comments( array $comments, WP_REST_Request $request )

Prepare activity comments.

Description

Parameters

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

Return

(array) An array of activity comments.

Source

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

protected function prepare_activity_comments( $comments, $request ) {
    $data = array();
 
    if ( empty( $comments ) ) {
        return $data;
    }
 
    foreach ( $comments as $comment ) {
        $data[] = $this->activity_endpoint->prepare_response_for_collection(
            $this->activity_endpoint->prepare_item_for_response( $comment, $request )
        );
    }
 
    /**
     * Filter activity comments returned from the API.
     *
     * @param array $data An array of activity comments.
     * @param array $comments Comments.
     * @param WP_REST_Request $request Request used to generate the response.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_activity_prepare_comments', $data, $comments, $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_prepare_comments	Filter activity comments returned from the API.

Used By
Used By	Description
bp-activity/classes/class-bp-rest-activity-comment-endpoint.php: BP_REST_Activity_Comment_Endpoint::get_items()	Retrieve activity comments.
bp-activity/classes/class-bp-rest-activity-comment-endpoint.php: BP_REST_Activity_Comment_Endpoint::create_item()	Create an activity comment.

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