Contents

Code Reference Classes BP_REST_Blogs_Endpoint BP_REST_Blogs_Endpoint::get_item()

BP_REST_Blogs_Endpoint::get_item( WP_REST_Request $request )

Retrieve a blog.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response|WP_Error)

Source

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

202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
public function get_item( $request ) {
    $blog = $this->get_blog_object( $request['id'] );
 
    if ( empty( $blog->blog_id ) || empty( $blog->admin_user_id ) ) {
        return new WP_Error(
            'bp_rest_blog_invalid_id',
            __( 'Invalid blog ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    $retval = array(
        $this->prepare_response_for_collection(
            $this->prepare_item_for_response( $blog, $request )
        ),
    );
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a blog is fetched via the REST API.
     *
     * @param stdClass         $blog     Fetched blog.
     * @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_blogs_get_item', $blog, $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.