WC_API_Orders::edit_order_note() public WC 2.2

Edit the order note

{} It's a method of the class: WC_API_Orders{}

Return

WP_Error|Array. error or edited note response data

Usage

$WC_API_Orders = new WC_API_Orders();
$WC_API_Orders->edit_order_note( $order_id, $id, $data );

$order_id(string) (required)

order ID

$id(string) (required)

note ID

$data(array) (required)

parsed request data

Changelog

Code of WC_API_Orders::edit_order_note() WC API Orders::edit order note ^{WC 5.6.0}

public function edit_order_note( $order_id, $id, $data ) {
	try {
		if ( ! isset( $data['order_note'] ) ) {
			throw new WC_API_Exception( 'woocommerce_api_missing_order_note_data', sprintf( __( 'No %1$s data specified to edit %1$s', 'woocommerce' ), 'order_note' ), 400 );
		}

		$data = $data['order_note'];

		// Validate order ID
		$order_id = $this->validate_request( $order_id, $this->post_type, 'edit' );

		if ( is_wp_error( $order_id ) ) {
			return $order_id;
		}

		$order = wc_get_order( $order_id );

		// Validate note ID
		$id = absint( $id );

		if ( empty( $id ) ) {
			throw new WC_API_Exception( 'woocommerce_api_invalid_order_note_id', __( 'Invalid order note ID', 'woocommerce' ), 400 );
		}

		// Ensure note ID is valid
		$note = get_comment( $id );

		if ( is_null( $note ) ) {
			throw new WC_API_Exception( 'woocommerce_api_invalid_order_note_id', __( 'An order note with the provided ID could not be found', 'woocommerce' ), 404 );
		}

		// Ensure note ID is associated with given order
		if ( $note->comment_post_ID != $order->get_id() ) {
			throw new WC_API_Exception( 'woocommerce_api_invalid_order_note_id', __( 'The order note ID provided is not associated with the order', 'woocommerce' ), 400 );
		}

		$data = apply_filters( 'woocommerce_api_edit_order_note_data', $data, $note->comment_ID, $order->get_id(), $this );

		// Note content
		if ( isset( $data['note'] ) ) {

			wp_update_comment(
				array(
					'comment_ID'      => $note->comment_ID,
					'comment_content' => $data['note'],
				)
			);
		}

		// Customer note
		if ( isset( $data['customer_note'] ) ) {

			update_comment_meta( $note->comment_ID, 'is_customer_note', true === $data['customer_note'] ? 1 : 0 );
		}

		do_action( 'woocommerce_api_edit_order_note', $note->comment_ID, $order->get_id(), $this );

		return $this->get_order_note( $order->get_id(), $note->comment_ID );
	} catch ( WC_Data_Exception $e ) {
		return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => 400 ) );
	} catch ( WC_API_Exception $e ) {
		return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
	}
}