• Home
  • Give_Payments_Query

PHP Class Give_Payments_Query, Give

This class is for retrieving payments data. Payments can be retrieved for date ranges and pre-defined periods.
Since: 1.0
Inheritance: extends Give_Stats
Mostra file Open project: wordimpress/give Class Usage Examples

Public Properties

Property Type Description
$args array The args to pass to the give_get_payments() query
$payments array The payments found based on the criteria set

Public Methods

Method Description
__construct ( $args = [] ) Default query arguments.
__set ( $query_var, $value ) Set a query variable.
__unset ( $query_var ) Unset a query variable.
children ( ) : void Children
date_filter_post ( ) : void If querying a specific date, remove filters after the query has been run to avoid affecting future queries.
date_filter_pre ( ) : void If querying a specific date, add the proper filters.
get_payments ( ) : object Retrieve payments.
give_forms ( ) : void Specific Give Form
init ( ) : void Modify the query/query arguments before we retrieve payments.
mode ( ) : void Payment Mode
month ( ) : void Current Month
orderby ( ) : void Order by
page ( ) : void Current Page
per_page ( ) : void Posts Per Page
search ( ) : void Search
status ( ) : void Post Status
user ( ) : void Specific User

Method Details

__construct() public method

Not all of these are valid arguments that can be passed to WP_Query. The ones that are not, are modified before the query is run to convert them to the proper syntax.
Since: 1.0
public __construct ( $args = [] )
$args array The array of arguments that can be passed in and used for setting up this payment query.

__set() public method

Set a query variable.
Since: 1.0
public __set ( $query_var, $value )

__unset() public method

Unset a query variable.
Since: 1.0
public __unset ( $query_var )

children() public method

Children
Since: 1.0
public children ( ) : void
return void

date_filter_post() public method

If querying a specific date, remove filters after the query has been run to avoid affecting future queries.
Since: 1.0
public date_filter_post ( ) : void
return void

date_filter_pre() public method

If querying a specific date, add the proper filters.
Since: 1.0
public date_filter_pre ( ) : void
return void

get_payments() public method

The query can be modified in two ways; either the action before the query is run, or the filter on the arguments (existing mainly for backwards compatibility).
Since: 1.0
public get_payments ( ) : object
return object

give_forms() public method

Specific Give Form
Since: 1.0
public give_forms ( ) : void
return void

init() public method

Modify the query/query arguments before we retrieve payments.
Since: 1.0
public init ( ) : void
return void

mode() public method

Payment Mode
Since: 1.0
public mode ( ) : void
return void

month() public method

Current Month
Since: 1.0
public month ( ) : void
return void

orderby() public method

Order by
Since: 1.0
public orderby ( ) : void
return void

page() public method

Current Page
Since: 1.0
public page ( ) : void
return void

per_page() public method

Posts Per Page
Since: 1.0
public per_page ( ) : void
return void

status() public method

Post Status
Since: 1.0
public status ( ) : void
return void

user() public method

Specific User
Since: 1.0
public user ( ) : void
return void

Property Details

$args public_oe property

The args to pass to the give_get_payments() query
Since: 1.0
public array $args
return array

$payments public_oe property

The payments found based on the criteria set
Since: 1.0
public array $payments
return array