Skip to content
Docs
Get RestroPress

Filter

rpress_payment

Updated
On this page

Filters each payment object collected by RPRESS_Payments_Query::get_payments.

Applied to every payment found by the query, after the RPRESS_Payment object has been loaded and, when sequential order numbers are enabled, payment_number has been set. The returned object is what ends up in the query's payments array.

Parameters#

ParameterTypeDescription
$paymentRPRESS_PaymentThe payment object.
$payment_idintID of the payment.
$queryRPRESS_Payments_QueryThe payments query object.

Return value#

RPRESS_Payment. The payment object to include in the results.

Example#

function my_tag_payment( $payment, $payment_id, $query ) {
	$payment->my_flag = (bool) get_post_meta( $payment_id, '_my_flag', true );
	return $payment;
}
add_filter( 'rpress_payment', 'my_tag_payment', 10, 3 );

Source#

Applied in:

  • includes/payments/class-payments-query.php (line 190), in RPRESS_Payments_Query::get_payments()

See also#

Was this page helpful?