pmpro_next_payment

Filter the next payment date.

Description

apply_filters( 'pmpro_next_payment', (mixed) $r, (int) $user_id, (string) $order_status ); 

Parameters (3)

0. $r (mixed)
False or the next payment date timestamp
1. $user_id (int)
The user id to get the next payment date for
2. $order_status (string)
Status or array of statuses to find the last order based on.

Usage

To run the hook, copy the example below.
  1. $r = apply_filters( 'pmpro_next_payment', $r, $user_id, $order_status ); 
  2.  
  3. if ( !empty( $r ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the pmpro_next_payment callback 
  2. function filter_pmpro_next_payment( $r, $user_id, $order_status ) { 
  3. // make filter magic happen here... 
  4. return $r
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'pmpro_next_payment', 'filter_pmpro_next_payment', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'pmpro_next_payment', 'filter_pmpro_next_payment', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/includes/functions.php  
  1. $r = apply_filters('pmpro_next_payment', $r, $user_id, $order_status);