Skip to content
Docs
Get RestroPress

Filter

rpress_payment_number

Updated
On this page

Filters the order number returned for a payment.

Runs when the order number property is read from an RPRESS_Payment object (for example $payment->number), through the object's magic getter. The number is the payment ID, or the stored sequential number when sequential order numbers are enabled. Reads made inside the class itself go straight to the property and are not filtered.

Parameters#

ParameterTypeDescription
$numberint|stringThe value loaded for the payment.
$payment_idintThe payment (order) ID.
$paymentRPRESS_PaymentThe payment object being read.

Return value#

int|string. The (possibly modified) value returned for the property.

Example#

add_filter( 'rpress_payment_number', 'my_prefix_payment_number', 10, 3 );
function my_prefix_payment_number( $number, $payment_id, $payment ) {
	return '#' . $number;
}

Source#

Applied in:

  • includes/payments/class-rpress-payment.php (line 2304), in RPRESS_Payment::get_number()

See also#

Was this page helpful?