Skip to content
Docs
Get RestroPress

Action

rpress_payment_delete

Updated
On this page

Fires before an order is permanently deleted.

Runs inside the delete routine after the order's sale stats have been reversed and, for trashed orders, earnings and customer totals decreased. The order post and its metadata still exist at this point, so use it to read data before it is removed.

Parameters#

ParameterTypeDescription
$payment_idintThe ID of the order being deleted.

Example#

function my_before_order_delete( $payment_id ) {
	$transaction_id = get_post_meta( $payment_id, 'my_external_id', true );
	if ( $transaction_id ) {
		update_option( 'my_last_deleted_external_id', $transaction_id );
	}
}
add_action( 'rpress_payment_delete', 'my_before_order_delete' );

Notes#

Fired from rpress_delete_order() and from the older rpress_delete_purchase() in the payments functions. RestroPress itself uses it to clear cached payment counts.

Source#

Fired from:

  • includes/admin/orders/actions.php (line 359), in rpress_delete_order()
  • includes/payments/functions.php (line 379), in rpress_delete_purchase()

See also#

Was this page helpful?