Skip to content
Docs
Get RestroPress

Filter

rpress_get_payments_args

Updated
On this page

Filters the query arguments passed to RPRESS_Payments_Query by rpress_get_payments().

Runs inside rpress_get_payments() after the 'output' argument is defaulted to 'posts' (when the caller did not provide one) and before RPRESS_Payments_Query is created. Use it to force or alter arguments such as 'number', 'status' or 'orderby' for every call. The filter affects every caller of rpress_get_payments(), including admin lists and reports.

Parameters#

ParameterTypeDescription
$argsarrayArguments for RPRESS_Payments_Query, for example 'number', 'status', 'user', 'customer', 'orderby', 'output'.

Return value#

array. The query arguments to use.

Example#

add_filter( 'rpress_get_payments_args', 'my_limit_payments_query', 10, 1 );
function my_limit_payments_query( $args ) {
	if ( isset( $args['number'] ) && (int) $args['number'] === -1 ) {
		$args['number'] = 500;
	}
	return $args;
}

Source#

Applied in:

  • includes/payments/functions.php (line 81), in rpress_get_payments()

See also#

Was this page helpful?