Contents

Code Reference Classes BP_REST_Media_Albums_Endpoint BP_REST_Media_Albums_Endpoint::create_item()

BP_REST_Media_Albums_Endpoint::create_item( WP_REST_Request $request )

Create medias.

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

391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
public function create_item( $request ) {
 
    $args = array(
        'upload_ids' => $request['upload_ids'],
        'privacy'    => $request['privacy'],
        'title'      => $request['title'],
        'user_id'    => ( ! empty( $request['user_id'] ) ? (int) $request['user_id'] : get_current_user_id() ),
    );
 
    if ( empty( $request['title'] ) ) {
        return new WP_Error(
            'bp_rest_no_album_title_not_found',
            __( 'Sorry, you are not allowed to create a Album.', 'buddyboss' ),
            array(
                'status' => 400,
            )
        );
    }
 
    if ( isset( $request['group_id'] ) && ! empty( $request['group_id'] ) ) {
        $args['group_id'] = $request['group_id'];
    }
 
    /**
     * Filter the query arguments for the request.
     *
     * @param array           $args    Key value array of query var to query value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    $args = apply_filters( 'bp_rest_media_albums_create_items_query_args', $args, $request );
 
    $album = $this->bp_rest_create_media_album( $args );
 
    if ( is_wp_error( $album ) ) {
        return $album;
    }
 
    $medias = $this->assemble_response_data( array( 'album_ids' => $album['album_id'] ) );
 
    $retval = array(
        'created' => $album['created'],
        'error'   => $album['error'],
    );
 
    foreach ( $medias['albums'] as $album ) {
        $retval['album'] = $this->prepare_response_for_collection(
            $this->prepare_item_for_response( $album, $request )
        );
    }
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a Media is created 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_album_create_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/classes/class-bp-rest-media-albums-endpoint.php: BP_REST_Media_Albums_Endpoint::bp_rest_create_media_album()

Create the Media Album.
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-albums-endpoint.php: bp_rest_media_albums_create_items_query_args

Filter the query arguments for the request.
bp-media/classes/class-bp-rest-media-albums-endpoint.php: bp_rest_media_album_create_item

Fires after a Media is created via the REST API.

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.