Skip to content
Docs
Get RestroPress

Filter

rpress_get_payment_meta

Updated
On this page

Filters a payment meta value returned by RPRESS_Payment::get_meta.

Applied as the last step of get_meta for every meta key, after the key-specific filter and after unsafe serialized objects have been discarded. Use it when one callback must handle several meta keys.

Parameters#

ParameterTypeDescription
$metamixedThe meta value.
$payment_idintID of the payment.
$meta_keystringThe meta key that was requested.

Return value#

mixed. The meta value to return.

Example#

function my_get_payment_meta( $meta, $payment_id, $meta_key ) {
	if ( '_my_reference' === $meta_key && empty( $meta ) ) {
		return 'n/a';
	}
	return $meta;
}
add_filter( 'rpress_get_payment_meta', 'my_get_payment_meta', 10, 3 );

Source#

Applied in:

  • includes/payments/class-rpress-payment.php (line 1539), in RPRESS_Payment::get_meta()
Was this page helpful?