WC_REST_Order_Notes_Controller::create_item()publicWC 1.0

Create a single order note.

Method of the class: WC_REST_Order_Notes_Controller{}

Hooks from the method

Return

WP_Error|WP_REST_Response.

Usage

$WC_REST_Order_Notes_Controller = new WC_REST_Order_Notes_Controller();
$WC_REST_Order_Notes_Controller->create_item( $request );
$request(WP_REST_Request) (required)
Full details about the request.

WC_REST_Order_Notes_Controller::create_item() code WC 8.6.1

public function create_item( $request ) {
	if ( ! empty( $request['id'] ) ) {
		/* translators: %s: post type */
		return new WP_Error( "woocommerce_rest_{$this->post_type}_exists", sprintf( __( 'Cannot create existing %s.', 'woocommerce' ), $this->post_type ), array( 'status' => 400 ) );
	}

	$order = wc_get_order( (int) $request['order_id'] );

	if ( ! $order || $this->post_type !== $order->get_type() ) {
		return new WP_Error( 'woocommerce_rest_order_invalid_id', __( 'Invalid order ID.', 'woocommerce' ), array( 'status' => 404 ) );
	}

	// Create the note.
	$note_id = $order->add_order_note( $request['note'], $request['customer_note'], $request['added_by_user'] );

	if ( ! $note_id ) {
		return new WP_Error( 'woocommerce_api_cannot_create_order_note', __( 'Cannot create order note, please try again.', 'woocommerce' ), array( 'status' => 500 ) );
	}

	$note = get_comment( $note_id );
	$this->update_additional_fields_for_object( $note, $request );

	/**
	 * Fires after a order note is created or updated via the REST API.
	 *
	 * @param WP_Comment      $note      New order note object.
	 * @param WP_REST_Request $request   Request object.
	 * @param boolean         $creating  True when creating item, false when updating.
	 */
	do_action( 'woocommerce_rest_insert_order_note', $note, $request, true );

	$request->set_param( 'context', 'edit' );
	$response = $this->prepare_item_for_response( $note, $request );
	$response = rest_ensure_response( $response );
	$response->set_status( 201 );
	$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, str_replace( '(?P<order_id>[\d]+)', $order->get_id(), $this->rest_base ), $note_id ) ) );

	return $response;
}