Contents

Code Reference Classes BP_REST_Notifications_Endpoint BP_REST_Notifications_Endpoint::create_item()

BP_REST_Notifications_Endpoint::create_item( WP_REST_Request $request )

Create a notification.

Description

Parameters

$request

(Required) Full data about the request.

Return

(WP_REST_Response) | WP_Error

Source

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

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
public function create_item( $request ) {
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    $notification_id = bp_notifications_add_notification( $this->prepare_item_for_database( $request ) );
 
    if ( ! is_numeric( $notification_id ) ) {
        return new WP_Error(
            'bp_rest_user_cannot_create_notification',
            __( 'Cannot create new notification.', 'buddyboss' ),
            array(
                'status' => 500,
            )
        );
    }
 
    $notification  = $this->get_notification_object( $notification_id );
    $fields_update = $this->update_additional_fields_for_object( $notification, $request );
 
    if ( is_wp_error( $fields_update ) ) {
        return $fields_update;
    }
 
    $retval = $this->prepare_response_for_collection(
        $this->prepare_item_for_response( $notification, $request )
    );
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a notification is created via the REST API.
     *
     * @param BP_Notifications_Notification $notification The created notification.
     * @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_notifications_create_item', $notification, $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-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::prepare_item_for_database()

Prepare a notification for create or update.
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::get_notification_object()

Get notification object.
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::prepare_item_for_response()

Prepares notification data for return as an object.
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: bp_rest_notifications_create_item

Fires after a notification is created via the REST API.
bp-notifications/bp-notifications-functions.php: bp_notifications_add_notification()

Add a notification for a specific user, from a specific component.

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.